public final class AdBreak extends GeneratedMessageV3 implements AdBreakOrBuilder The AdBreak resource.
Protobuf type google.ads.admanager.v1.AdBreak
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AdBreakImplements
AdBreakOrBuilderStatic Fields
AD_BREAK_ID_FIELD_NUMBER
public static final int AD_BREAK_ID_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ASSET_KEY_FIELD_NUMBER
public static final int ASSET_KEY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
BREAK_SEQUENCE_FIELD_NUMBER
public static final int BREAK_SEQUENCE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
BREAK_STATE_FIELD_NUMBER
public static final int BREAK_STATE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CUSTOM_ASSET_KEY_FIELD_NUMBER
public static final int CUSTOM_ASSET_KEY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CUSTOM_PARAMS_FIELD_NUMBER
public static final int CUSTOM_PARAMS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DURATION_FIELD_NUMBER
public static final int DURATION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
EXPECTED_START_TIME_FIELD_NUMBER
public static final int EXPECTED_START_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
POD_TEMPLATE_NAME_FIELD_NUMBER
public static final int POD_TEMPLATE_NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SCTE_35_CUE_OUT_FIELD_NUMBER
public static final int SCTE_35_CUE_OUT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static AdBreak getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
AdBreak |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static AdBreak.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
newBuilder(AdBreak prototype)
public static AdBreak.Builder newBuilder(AdBreak prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
AdBreak |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
parseDelimitedFrom(InputStream input)
public static AdBreak parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
AdBreak |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AdBreak parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AdBreak |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static AdBreak parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
AdBreak |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AdBreak parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AdBreak |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static AdBreak parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
AdBreak |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AdBreak parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AdBreak |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static AdBreak parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
AdBreak |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AdBreak parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AdBreak |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static AdBreak parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
AdBreak |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AdBreak parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AdBreak |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static AdBreak parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
AdBreak |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AdBreak parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AdBreak |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<AdBreak> parser()| Returns | |
|---|---|
| Type | Description |
Parser<AdBreak> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAdBreakId()
public 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 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 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 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 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 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 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 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 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 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 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. |
getDefaultInstanceForType()
public AdBreak getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
AdBreak |
|
getDuration()
public 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 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 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 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 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 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. |
getParserForType()
public Parser<AdBreak> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<AdBreak> |
|
getPodTemplateName()
public 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 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 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 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. |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
hasAdBreakId()
public 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 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 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 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 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 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 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 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 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 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. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public AdBreak.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AdBreak.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public AdBreak.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|