public static final class AdBreak.Builder extends GeneratedMessageV3.Builder<AdBreak.Builder> implements AdBreakOrBuilder The AdBreak resource.
Protobuf type google.ads.admanager.v1.AdBreak
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AdBreak.BuilderImplements
AdBreakOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public AdBreak.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
build()
public AdBreak build()| Returns | |
|---|---|
| Type | Description |
AdBreak |
|
buildPartial()
public AdBreak buildPartial()| Returns | |
|---|---|
| Type | Description |
AdBreak |
|
clear()
public AdBreak.Builder clear()| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
clearAdBreakId()
public AdBreak.Builder clearAdBreakId() 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 |
AdBreak.Builder |
This builder for chaining. |
clearAssetKey()
public AdBreak.Builder clearAssetKey() 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 |
AdBreak.Builder |
This builder for chaining. |
clearBreakSequence()
public AdBreak.Builder clearBreakSequence() 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 |
AdBreak.Builder |
This builder for chaining. |
clearBreakState()
public AdBreak.Builder clearBreakState() 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 |
AdBreak.Builder |
This builder for chaining. |
clearCustomAssetKey()
public AdBreak.Builder clearCustomAssetKey() 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 |
AdBreak.Builder |
This builder for chaining. |
clearCustomParams()
public AdBreak.Builder clearCustomParams() 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 |
AdBreak.Builder |
This builder for chaining. |
clearDuration()
public AdBreak.Builder clearDuration() 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 |
AdBreak.Builder |
|
clearExpectedStartTime()
public AdBreak.Builder clearExpectedStartTime()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 |
AdBreak.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public AdBreak.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
clearName()
public AdBreak.Builder clearName() 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 |
AdBreak.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public AdBreak.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
clearPodTemplateName()
public AdBreak.Builder clearPodTemplateName() 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 |
AdBreak.Builder |
This builder for chaining. |
clearScte35CueOut()
public AdBreak.Builder clearScte35CueOut() 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 |
AdBreak.Builder |
This builder for chaining. |
clone()
public AdBreak.Builder clone()| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getDurationBuilder()
public Duration.Builder getDurationBuilder() 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 |
Builder |
|
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. |
getExpectedStartTimeBuilder()
public Timestamp.Builder getExpectedStartTimeBuilder()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 |
Builder |
|
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. |
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeDuration(Duration value)
public AdBreak.Builder mergeDuration(Duration value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
mergeExpectedStartTime(Timestamp value)
public AdBreak.Builder mergeExpectedStartTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
mergeFrom(AdBreak other)
public AdBreak.Builder mergeFrom(AdBreak other)| Parameter | |
|---|---|
| Name | Description |
other |
AdBreak |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public AdBreak.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public AdBreak.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AdBreak.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
setAdBreakId(String value)
public AdBreak.Builder setAdBreakId(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe adBreakId to set. |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
This builder for chaining. |
setAdBreakIdBytes(ByteString value)
public AdBreak.Builder setAdBreakIdBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for adBreakId to set. |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
This builder for chaining. |
setAssetKey(String value)
public AdBreak.Builder setAssetKey(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe assetKey to set. |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
This builder for chaining. |
setAssetKeyBytes(ByteString value)
public AdBreak.Builder setAssetKeyBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for assetKey to set. |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
This builder for chaining. |
setBreakSequence(long value)
public AdBreak.Builder setBreakSequence(long value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe breakSequence to set. |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
This builder for chaining. |
setBreakState(AdBreakStateEnum.AdBreakState value)
public AdBreak.Builder setBreakState(AdBreakStateEnum.AdBreakState value) Output only. The state of the AdBreak.
optional .google.ads.admanager.v1.AdBreakStateEnum.AdBreakState break_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
AdBreakStateEnum.AdBreakStateThe breakState to set. |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
This builder for chaining. |
setBreakStateValue(int value)
public AdBreak.Builder setBreakStateValue(int value) Output only. The state of the AdBreak.
optional .google.ads.admanager.v1.AdBreakStateEnum.AdBreakState break_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for breakState to set. |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
This builder for chaining. |
setCustomAssetKey(String value)
public AdBreak.Builder setCustomAssetKey(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe customAssetKey to set. |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
This builder for chaining. |
setCustomAssetKeyBytes(ByteString value)
public AdBreak.Builder setCustomAssetKeyBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for customAssetKey to set. |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
This builder for chaining. |
setCustomParams(String value)
public AdBreak.Builder setCustomParams(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe customParams to set. |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
This builder for chaining. |
setCustomParamsBytes(ByteString value)
public AdBreak.Builder setCustomParamsBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for customParams to set. |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
This builder for chaining. |
setDuration(Duration value)
public AdBreak.Builder setDuration(Duration value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
setDuration(Duration.Builder builderForValue)
public AdBreak.Builder setDuration(Duration.Builder builderForValue) 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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
setExpectedStartTime(Timestamp value)
public AdBreak.Builder setExpectedStartTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
setExpectedStartTime(Timestamp.Builder builderForValue)
public AdBreak.Builder setExpectedStartTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public AdBreak.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
setName(String value)
public AdBreak.Builder setName(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public AdBreak.Builder setNameBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
This builder for chaining. |
setPodTemplateName(String value)
public AdBreak.Builder setPodTemplateName(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe podTemplateName to set. |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
This builder for chaining. |
setPodTemplateNameBytes(ByteString value)
public AdBreak.Builder setPodTemplateNameBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for podTemplateName to set. |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public AdBreak.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|
setScte35CueOut(String value)
public AdBreak.Builder setScte35CueOut(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe scte35CueOut to set. |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
This builder for chaining. |
setScte35CueOutBytes(ByteString value)
public AdBreak.Builder setScte35CueOutBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for scte35CueOut to set. |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final AdBreak.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
AdBreak.Builder |
|