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
ASSET_KEY_FIELD_NUMBER
public
static
final
int
ASSET_KEY_FIELD_NUMBER
BREAK_SEQUENCE_FIELD_NUMBER
public
static
final
int
BREAK_SEQUENCE_FIELD_NUMBER
BREAK_STATE_FIELD_NUMBER
public
static
final
int
BREAK_STATE_FIELD_NUMBER
CUSTOM_ASSET_KEY_FIELD_NUMBER
public
static
final
int
CUSTOM_ASSET_KEY_FIELD_NUMBER
CUSTOM_PARAMS_FIELD_NUMBER
public
static
final
int
CUSTOM_PARAMS_FIELD_NUMBER
DURATION_FIELD_NUMBER
public
static
final
int
DURATION_FIELD_NUMBER
EXPECTED_START_TIME_FIELD_NUMBER
public
static
final
int
EXPECTED_START_TIME_FIELD_NUMBER
NAME_FIELD_NUMBER
public
static
final
int
NAME_FIELD_NUMBER
POD_TEMPLATE_NAME_FIELD_NUMBER
public
static
final
int
POD_TEMPLATE_NAME_FIELD_NUMBER
SCTE_35_CUE_OUT_FIELD_NUMBER
public
static
final
int
SCTE_35_CUE_OUT_FIELD_NUMBER
Static Methods
getDefaultInstance()
public
static
AdBreak
getDefaultInstance
()
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
newBuilder()
public
static
AdBreak
.
Builder
newBuilder
()
newBuilder(AdBreak prototype)
public
static
AdBreak
.
Builder
newBuilder
(
AdBreak
prototype
)
parseDelimitedFrom(InputStream input)
public
static
AdBreak
parseDelimitedFrom
(
InputStream
input
)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
AdBreak
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(byte[] data)
public
static
AdBreak
parseFrom
(
byte
[]
data
)
data
byte
[]
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
AdBreak
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteString data)
public
static
AdBreak
parseFrom
(
ByteString
data
)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
AdBreak
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(CodedInputStream input)
public
static
AdBreak
parseFrom
(
CodedInputStream
input
)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public
static
AdBreak
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(InputStream input)
public
static
AdBreak
parseFrom
(
InputStream
input
)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
AdBreak
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteBuffer data)
public
static
AdBreak
parseFrom
(
ByteBuffer
data
)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
AdBreak
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
parser()
public
static
Parser<AdBreak>
parser
()
Methods
equals(Object obj)
public
boolean
equals
(
Object
obj
)
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];
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];
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];
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];
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];
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];
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];
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];
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];
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];
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];
getDefaultInstanceForType()
public
AdBreak
getDefaultInstanceForType
()
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];
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];
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];
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];
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];
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];
getParserForType()
public
Parser<AdBreak>
getParserForType
()
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];
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];
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];
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];
getSerializedSize()
public
int
getSerializedSize
()
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];
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];
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];
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];
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];
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];
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];
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];
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];
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];
hashCode()
public
int
hashCode
()
internalGetFieldAccessorTable()
protected
GeneratedMessageV3
.
FieldAccessorTable
internalGetFieldAccessorTable
()
isInitialized()
public
final
boolean
isInitialized
()
newBuilderForType()
public
AdBreak
.
Builder
newBuilderForType
()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected
AdBreak
.
Builder
newBuilderForType
(
GeneratedMessageV3
.
BuilderParent
parent
)
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected
Object
newInstance
(
GeneratedMessageV3
.
UnusedPrivateParameter
unused
)
toBuilder()
public
AdBreak
.
Builder
toBuilder
()
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
