Reference documentation and code samples for the Google Ads Ad Manager V1 Client class ListAdBreaksRequest.
Request object for ListAdBreaks
method.
Generated from protobuf message google.ads.admanager.v1.ListAdBreaksRequest
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent, which owns this collection of AdBreaks. Formats: |
↳ page_size |
int
Optional. The maximum number of |
↳ page_token |
string
Optional. A page token, received from a previous |
↳ filter |
string
Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters |
↳ order_by |
string
Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order |
↳ skip |
int
Optional. Number of individual resources to skip while paginating. |
getParent
Required. The parent, which owns this collection of AdBreaks.
Formats:
networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}
networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}
Returns | |
---|---|
Type | Description |
string |
setParent
Required. The parent, which owns this collection of AdBreaks.
Formats:
networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}
networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPageSize
Optional. The maximum number of AdBreaks
to return. The service might
return fewer than this value. If unspecified, at most 10 ad breaks are
returned. The maximum value is 100
. Values above 100
are coerced to
100
.
Returns | |
---|---|
Type | Description |
int |
setPageSize
Optional. The maximum number of AdBreaks
to return. The service might
return fewer than this value. If unspecified, at most 10 ad breaks are
returned. The maximum value is 100
. Values above 100
are coerced to
100
.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getPageToken
Optional. A page token, received from a previous ListAdBreaks
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListAdBreaks
must match
the call that provided the page token.
Returns | |
---|---|
Type | Description |
string |
setPageToken
Optional. A page token, received from a previous ListAdBreaks
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListAdBreaks
must match
the call that provided the page token.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFilter
Optional. Expression to filter the response.
See syntax details at https://developers.google.com/ad-manager/api/beta/filters
Returns | |
---|---|
Type | Description |
string |
setFilter
Optional. Expression to filter the response.
See syntax details at https://developers.google.com/ad-manager/api/beta/filters
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getOrderBy
Optional. Expression to specify sorting order.
See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
Returns | |
---|---|
Type | Description |
string |
setOrderBy
Optional. Expression to specify sorting order.
See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getSkip
Optional. Number of individual resources to skip while paginating.
Returns | |
---|---|
Type | Description |
int |
setSkip
Optional. Number of individual resources to skip while paginating.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameter | |
---|---|
Name | Description |
parent |
string
Required. The parent, which owns this collection of AdBreaks. Formats:
|
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest |