Reference documentation and code samples for the Google Ads Ad Manager V1 Client class AdBreak.
The AdBreak
resource.
Generated from protobuf message google.ads.admanager.v1.AdBreak
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the |
↳ ad_break_id |
string
Optional. Immutable. |
↳ asset_key |
string
Optional. Immutable. The asset key of the |
↳ custom_asset_key |
string
Optional. Immutable. The custom asset key of the |
↳ expected_start_time |
Google\Protobuf\Timestamp
Optional. The expected start time of the ad break. When set, the scheduled ad break will be decisioned shortly before the expected start time. If this field is not set, ad decisioning begins immediately. An ad break can be created up to six hours before the expected start time. |
↳ duration |
Google\Protobuf\Duration
Required. The duration of the |
↳ break_state |
int
Output only. The state of the |
↳ break_sequence |
int|string
Output only. The sequence id of the |
↳ pod_template_name |
string
Optional. The pod template name of the |
↳ custom_params |
string
Optional. The key-value pairs to be included on the ad requests for this |
↳ scte_35_cue_out |
string
Optional. The Base64-encoded SCTE-35 command associated with the |
getName
Identifier. The resource name of the AdBreak
.
This field uses the LiveStreamEvent
resource's asset key in the
URI, even if the ad break was created, updated, or queried using the custom
asset key.
Format:
networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break_id}
Returns | |
---|---|
Type | Description |
string |
setName
Identifier. The resource name of the AdBreak
.
This field uses the LiveStreamEvent
resource's asset key in the
URI, even if the ad break was created, updated, or queried using the custom
asset key.
Format:
networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break_id}
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getAdBreakId
Optional. Immutable. AdBreak
ID.
Must consist only of lowercase letters, digits, and hyphens. Ad break IDs have a maximum length of 63 characters. If not set, an ad break ID is generated as a UUID string.
Returns | |
---|---|
Type | Description |
string |
hasAdBreakId
clearAdBreakId
setAdBreakId
Optional. Immutable. AdBreak
ID.
Must consist only of lowercase letters, digits, and hyphens. Ad break IDs have a maximum length of 63 characters. If not set, an ad break ID is generated as a UUID string.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getAssetKey
Optional. Immutable. The asset key of the LiveStreamEvent
that the ad
break belongs to. Either an asset key or a custom asset key must be
provided for creation.
Returns | |
---|---|
Type | Description |
string |
hasAssetKey
clearAssetKey
setAssetKey
Optional. Immutable. The asset key of the LiveStreamEvent
that the ad
break belongs to. Either an asset key or a custom asset key must be
provided for creation.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getCustomAssetKey
Optional. Immutable. The custom asset key of the LiveStreamEvent
that the
ad break belongs to. Either an asset key or a custom asset key must be
provided for creation.
Returns | |
---|---|
Type | Description |
string |
hasCustomAssetKey
clearCustomAssetKey
setCustomAssetKey
Optional. Immutable. The custom asset key of the LiveStreamEvent
that the
ad break belongs to. Either an asset key or a custom asset key must be
provided for creation.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getExpectedStartTime
Optional. The expected start time of the ad break.
When set, the scheduled ad break will be decisioned shortly before the expected start time. If this field is not set, ad decisioning begins immediately. An ad break can be created up to six hours before the expected start time.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasExpectedStartTime
clearExpectedStartTime
setExpectedStartTime
Optional. The expected start time of the ad break.
When set, the scheduled ad break will be decisioned shortly before the expected start time. If this field is not set, ad decisioning begins immediately. An ad break can be created up to six hours before the expected start time.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getDuration
Required. The duration of the AdBreak
.
An expected duration in seconds with up to nine fractional digits, ending
with s
, for example, 3.5s
. This value will be updated to match the
actual duration from the manifest or pod request after the ad break's state
is
COMPLETE
.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Duration|null |
hasDuration
clearDuration
setDuration
Required. The duration of the AdBreak
.
An expected duration in seconds with up to nine fractional digits, ending
with s
, for example, 3.5s
. This value will be updated to match the
actual duration from the manifest or pod request after the ad break's state
is
COMPLETE
.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Duration
|
Returns | |
---|---|
Type | Description |
$this |
getBreakState
Output only. The state of the AdBreak
.
Returns | |
---|---|
Type | Description |
int |
hasBreakState
clearBreakState
setBreakState
Output only. The state of the AdBreak
.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getBreakSequence
Output only. The sequence id of the AdBreak
.
The unique sequence number of the created ad break. This value is only set
after the AdBreak
starts decisioning indicated by the ad break state's
being
DECISIONED
.
Returns | |
---|---|
Type | Description |
int|string |
hasBreakSequence
clearBreakSequence
setBreakSequence
Output only. The sequence id of the AdBreak
.
The unique sequence number of the created ad break. This value is only set
after the AdBreak
starts decisioning indicated by the ad break state's
being
DECISIONED
.
Parameter | |
---|---|
Name | Description |
var |
int|string
|
Returns | |
---|---|
Type | Description |
$this |
getPodTemplateName
Optional. The pod template name of the AdBreak
.
This field is the required unique name across all pod templates in the network, not the display name.
Returns | |
---|---|
Type | Description |
string |
hasPodTemplateName
clearPodTemplateName
setPodTemplateName
Optional. The pod template name of the AdBreak
.
This field is the required unique name across all pod templates in the network, not the display name.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getCustomParams
Optional. The key-value pairs to be included on the ad requests for this
AdBreak
. Key-value pairs to include on ad requests for this break for
custom criteria targeting in Google Ad Manager, separated by =
and joined
by
&
.
Format:"key1=value&key2=value"
Returns | |
---|---|
Type | Description |
string |
hasCustomParams
clearCustomParams
setCustomParams
Optional. The key-value pairs to be included on the ad requests for this
AdBreak
. Key-value pairs to include on ad requests for this break for
custom criteria targeting in Google Ad Manager, separated by =
and joined
by
&
.
Format:"key1=value&key2=value"
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getScte35CueOut
Optional. The Base64-encoded SCTE-35 command associated with the AdBreak
.
This field can include the splice_insert()
or time_signal()
command.
Examples
time_signal()
php /DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==
splice_insert()
php /DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo=
Returns | |
---|---|
Type | Description |
string |
hasScte35CueOut
clearScte35CueOut
setScte35CueOut
Optional. The Base64-encoded SCTE-35 command associated with the AdBreak
.
This field can include the splice_insert()
or time_signal()
command.
Examples
time_signal()
php /DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==
splice_insert()
php /DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo=
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |