public interface AdBreakOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAdBreakId()
public abstract String 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.
optional string ad_break_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
String |
The adBreakId. |
getAdBreakIdBytes()
public abstract ByteString getAdBreakIdBytes() 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.
optional string ad_break_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for adBreakId. |
getAssetKey()
public abstract String 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.
optional string asset_key = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
String |
The assetKey. |
getAssetKeyBytes()
public abstract ByteString getAssetKeyBytes() 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.
optional string asset_key = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for assetKey. |
getBreakSequence()
public abstract long 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
.
optional int64 break_sequence = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
long |
The breakSequence. |
getBreakState()
public abstract AdBreakStateEnum.AdBreakState getBreakState() Output only. The state of the AdBreak.
optional .google.ads.admanager.v1.AdBreakStateEnum.AdBreakState break_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
AdBreakStateEnum.AdBreakState |
The breakState. |
getBreakStateValue()
public abstract int getBreakStateValue() Output only. The state of the AdBreak.
optional .google.ads.admanager.v1.AdBreakStateEnum.AdBreakState break_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for breakState. |
getCustomAssetKey()
public abstract String 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.
optional string custom_asset_key = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
String |
The customAssetKey. |
getCustomAssetKeyBytes()
public abstract ByteString getCustomAssetKeyBytes() 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.
optional string custom_asset_key = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for customAssetKey. |
getCustomParams()
public abstract String 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"
optional string custom_params = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The customParams. |
getCustomParamsBytes()
public abstract ByteString getCustomParamsBytes() 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"
optional string custom_params = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for customParams. |
getDuration()
public abstract Duration 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.
optional .google.protobuf.Duration duration = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Duration |
The duration. |
getDurationOrBuilder()
public abstract DurationOrBuilder getDurationOrBuilder() 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.
optional .google.protobuf.Duration duration = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getExpectedStartTime()
public abstract Timestamp 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.
optional .google.protobuf.Timestamp expected_start_time = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The expectedStartTime. |
getExpectedStartTimeOrBuilder()
public abstract TimestampOrBuilder getExpectedStartTimeOrBuilder()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.
optional .google.protobuf.Timestamp expected_start_time = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getName()
public abstract String 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}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes() 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}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getPodTemplateName()
public abstract String 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.
optional string pod_template_name = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The podTemplateName. |
getPodTemplateNameBytes()
public abstract ByteString getPodTemplateNameBytes() 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.
optional string pod_template_name = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for podTemplateName. |
getScte35CueOut()
public abstract String 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()`/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==- splice_insert()
/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo=
optional string scte_35_cue_out = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The scte35CueOut. |
getScte35CueOutBytes()
public abstract ByteString getScte35CueOutBytes() 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()`/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==- splice_insert()
/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo=
optional string scte_35_cue_out = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for scte35CueOut. |
hasAdBreakId()
public abstract boolean hasAdBreakId() 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.
optional string ad_break_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the adBreakId field is set. |
hasAssetKey()
public abstract boolean hasAssetKey() 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.
optional string asset_key = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the assetKey field is set. |
hasBreakSequence()
public abstract boolean hasBreakSequence() 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
.
optional int64 break_sequence = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the breakSequence field is set. |
hasBreakState()
public abstract boolean hasBreakState() Output only. The state of the AdBreak.
optional .google.ads.admanager.v1.AdBreakStateEnum.AdBreakState break_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the breakState field is set. |
hasCustomAssetKey()
public abstract boolean hasCustomAssetKey() 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.
optional string custom_asset_key = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the customAssetKey field is set. |
hasCustomParams()
public abstract boolean hasCustomParams() 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"
optional string custom_params = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the customParams field is set. |
hasDuration()
public abstract boolean hasDuration() 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.
optional .google.protobuf.Duration duration = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the duration field is set. |
hasExpectedStartTime()
public abstract boolean hasExpectedStartTime()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.
optional .google.protobuf.Timestamp expected_start_time = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the expectedStartTime field is set. |
hasPodTemplateName()
public abstract boolean hasPodTemplateName() 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.
optional string pod_template_name = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the podTemplateName field is set. |
hasScte35CueOut()
public abstract boolean hasScte35CueOut() 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()`/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==- splice_insert()
/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo=
optional string scte_35_cue_out = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the scte35CueOut field is set. |