Class BreakTemplate.Builder (0.58.0)

0.58.0 (latest) 0.54.0 0.53.0 0.52.0 0.50.0 0.47.0 0.46.0 0.44.0 0.42.0 0.41.0 0.40.0 0.39.0 0.37.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.29.0 0.27.0 0.26.0 0.23.0 0.22.0 0.21.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public static final class BreakTemplate.Builder extends GeneratedMessage.Builder<BreakTemplate.Builder> implements BreakTemplateOrBuilder

A BreakTemplate defines what kinds of ads show at which positions within a pod. Break templates are made up of AdSpot objects. A break template must have a single ad spot that has flexible set to true.

Protobuf type google.ads.admanager.v1.BreakTemplate

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > BreakTemplate.Builder

Implements

BreakTemplateOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllBreakTemplateMembers(Iterable<? extends BreakTemplateMember> values)

public BreakTemplate.Builder addAllBreakTemplateMembers(Iterable<? extends BreakTemplateMember> values)

Optional. The list of the BreakTemplateMember objects in the order in which they should appear in the ad pod. Each BreakTemplateMember has a reference to an AdSpot, which defines what kinds of ads can appear at that position, as well as other metadata that defines how each ad spot should be filled.

repeated .google.ads.admanager.v1.BreakTemplateMember break_template_members = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Iterable<? extends com.google.ads.admanager.v1.BreakTemplateMember>

Returns
Type	Description
BreakTemplate.Builder

addBreakTemplateMembers(BreakTemplateMember value)

public BreakTemplate.Builder addBreakTemplateMembers(BreakTemplateMember value)

Optional. The list of the BreakTemplateMember objects in the order in which they should appear in the ad pod. Each BreakTemplateMember has a reference to an AdSpot, which defines what kinds of ads can appear at that position, as well as other metadata that defines how each ad spot should be filled.

repeated .google.ads.admanager.v1.BreakTemplateMember break_template_members = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	BreakTemplateMember

Returns
Type	Description
BreakTemplate.Builder

addBreakTemplateMembers(BreakTemplateMember.Builder builderForValue)

public BreakTemplate.Builder addBreakTemplateMembers(BreakTemplateMember.Builder builderForValue)

Optional. The list of the BreakTemplateMember objects in the order in which they should appear in the ad pod. Each BreakTemplateMember has a reference to an AdSpot, which defines what kinds of ads can appear at that position, as well as other metadata that defines how each ad spot should be filled.

repeated .google.ads.admanager.v1.BreakTemplateMember break_template_members = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	BreakTemplateMember.Builder

Returns
Type	Description
BreakTemplate.Builder

addBreakTemplateMembers(int index, BreakTemplateMember value)

public BreakTemplate.Builder addBreakTemplateMembers(int index, BreakTemplateMember value)

Optional. The list of the BreakTemplateMember objects in the order in which they should appear in the ad pod. Each BreakTemplateMember has a reference to an AdSpot, which defines what kinds of ads can appear at that position, as well as other metadata that defines how each ad spot should be filled.

repeated .google.ads.admanager.v1.BreakTemplateMember break_template_members = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	BreakTemplateMember

Returns
Type	Description
BreakTemplate.Builder

addBreakTemplateMembers(int index, BreakTemplateMember.Builder builderForValue)

public BreakTemplate.Builder addBreakTemplateMembers(int index, BreakTemplateMember.Builder builderForValue)

Optional. The list of the BreakTemplateMember objects in the order in which they should appear in the ad pod. Each BreakTemplateMember has a reference to an AdSpot, which defines what kinds of ads can appear at that position, as well as other metadata that defines how each ad spot should be filled.

repeated .google.ads.admanager.v1.BreakTemplateMember break_template_members = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	BreakTemplateMember.Builder

Returns
Type	Description
BreakTemplate.Builder

addBreakTemplateMembersBuilder()

public BreakTemplateMember.Builder addBreakTemplateMembersBuilder()

Optional. The list of the BreakTemplateMember objects in the order in which they should appear in the ad pod. Each BreakTemplateMember has a reference to an AdSpot, which defines what kinds of ads can appear at that position, as well as other metadata that defines how each ad spot should be filled.

repeated .google.ads.admanager.v1.BreakTemplateMember break_template_members = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BreakTemplateMember.Builder

addBreakTemplateMembersBuilder(int index)

public BreakTemplateMember.Builder addBreakTemplateMembersBuilder(int index)

Optional. The list of the BreakTemplateMember objects in the order in which they should appear in the ad pod. Each BreakTemplateMember has a reference to an AdSpot, which defines what kinds of ads can appear at that position, as well as other metadata that defines how each ad spot should be filled.

repeated .google.ads.admanager.v1.BreakTemplateMember break_template_members = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
BreakTemplateMember.Builder

build()

public BreakTemplate build()

Returns
Type	Description
BreakTemplate

buildPartial()

public BreakTemplate buildPartial()

Returns
Type	Description
BreakTemplate

clear()

public BreakTemplate.Builder clear()

Returns
Type	Description
BreakTemplate.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearAdBreakOptimizationType()

public BreakTemplate.Builder clearAdBreakOptimizationType()

Optional. The optimization type of the pod. This field is optional and defaults to [AdBreakOptimizationType.REVENUE][].

optional .google.ads.admanager.v1.AdBreakOptimizationTypeEnum.AdBreakOptimizationType ad_break_optimization_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BreakTemplate.Builder	This builder for chaining.

clearAdTagName()

public BreakTemplate.Builder clearAdTagName()

Optional. Name of the BreakTemplate. The name is case insensitive and can be referenced in ad tags. This value is required if customTemplate is true, and cannot be set otherwise. You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, ,, ~, ;, ^, (, ), <, >, [, ], the white space character.

optional string ad_tag_name = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BreakTemplate.Builder	This builder for chaining.

clearBreakTemplateMembers()

public BreakTemplate.Builder clearBreakTemplateMembers()

Optional. The list of the BreakTemplateMember objects in the order in which they should appear in the ad pod. Each BreakTemplateMember has a reference to an AdSpot, which defines what kinds of ads can appear at that position, as well as other metadata that defines how each ad spot should be filled.

repeated .google.ads.admanager.v1.BreakTemplateMember break_template_members = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BreakTemplate.Builder

clearCustomTemplate()

public BreakTemplate.Builder clearCustomTemplate()

Optional. Whether this is a custom template. Custom templates get created outside of the ad rule workflow and can be referenced in ad tags. Only custom templates can have names and display names.

optional bool custom_template = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BreakTemplate.Builder	This builder for chaining.

clearDisplayName()

public BreakTemplate.Builder clearDisplayName()

Optional. Descriptive name for the BreakTemplate. This value is optional if customTemplate is true, and cannot be set otherwise.

optional string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BreakTemplate.Builder	This builder for chaining.

clearFillOrderDirectionType()

public BreakTemplate.Builder clearFillOrderDirectionType()

Optional. The fill order direction of the pod. This value is required if adBreakOptimizationType is equal to [AdBreakOptimizationType.POSITION][] and should otherwise be unset.

optional .google.ads.admanager.v1.AdRuleFillOrderDirectionEnum.AdRuleFillOrderDirection fill_order_direction_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BreakTemplate.Builder	This builder for chaining.

clearName()

public BreakTemplate.Builder clearName()

Identifier. The resource name of the BreakTemplate. Format: networks/{network_code}/breakTemplates/{break_template_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
BreakTemplate.Builder	This builder for chaining.

getAdBreakOptimizationType()

public AdBreakOptimizationTypeEnum.AdBreakOptimizationType getAdBreakOptimizationType()

Optional. The optimization type of the pod. This field is optional and defaults to [AdBreakOptimizationType.REVENUE][].

optional .google.ads.admanager.v1.AdBreakOptimizationTypeEnum.AdBreakOptimizationType ad_break_optimization_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AdBreakOptimizationTypeEnum.AdBreakOptimizationType	The adBreakOptimizationType.

getAdBreakOptimizationTypeValue()

public int getAdBreakOptimizationTypeValue()

Optional. The optimization type of the pod. This field is optional and defaults to [AdBreakOptimizationType.REVENUE][].

optional .google.ads.admanager.v1.AdBreakOptimizationTypeEnum.AdBreakOptimizationType ad_break_optimization_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for adBreakOptimizationType.

getAdTagName()

public String getAdTagName()

Optional. Name of the BreakTemplate. The name is case insensitive and can be referenced in ad tags. This value is required if customTemplate is true, and cannot be set otherwise. You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, ,, ~, ;, ^, (, ), <, >, [, ], the white space character.

optional string ad_tag_name = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The adTagName.

getAdTagNameBytes()

public ByteString getAdTagNameBytes()

Optional. Name of the BreakTemplate. The name is case insensitive and can be referenced in ad tags. This value is required if customTemplate is true, and cannot be set otherwise. You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, ,, ~, ;, ^, (, ), <, >, [, ], the white space character.

optional string ad_tag_name = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for adTagName.

getBreakTemplateMembers(int index)

public BreakTemplateMember getBreakTemplateMembers(int index)

Optional. The list of the BreakTemplateMember objects in the order in which they should appear in the ad pod. Each BreakTemplateMember has a reference to an AdSpot, which defines what kinds of ads can appear at that position, as well as other metadata that defines how each ad spot should be filled.

repeated .google.ads.admanager.v1.BreakTemplateMember break_template_members = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
BreakTemplateMember

getBreakTemplateMembersBuilder(int index)

public BreakTemplateMember.Builder getBreakTemplateMembersBuilder(int index)

Optional. The list of the BreakTemplateMember objects in the order in which they should appear in the ad pod. Each BreakTemplateMember has a reference to an AdSpot, which defines what kinds of ads can appear at that position, as well as other metadata that defines how each ad spot should be filled.

repeated .google.ads.admanager.v1.BreakTemplateMember break_template_members = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
BreakTemplateMember.Builder

getBreakTemplateMembersBuilderList()

public List<BreakTemplateMember.Builder> getBreakTemplateMembersBuilderList()

Optional. The list of the BreakTemplateMember objects in the order in which they should appear in the ad pod. Each BreakTemplateMember has a reference to an AdSpot, which defines what kinds of ads can appear at that position, as well as other metadata that defines how each ad spot should be filled.

repeated .google.ads.admanager.v1.BreakTemplateMember break_template_members = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Builder>

getBreakTemplateMembersCount()

public int getBreakTemplateMembersCount()

Optional. The list of the BreakTemplateMember objects in the order in which they should appear in the ad pod. Each BreakTemplateMember has a reference to an AdSpot, which defines what kinds of ads can appear at that position, as well as other metadata that defines how each ad spot should be filled.

repeated .google.ads.admanager.v1.BreakTemplateMember break_template_members = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getBreakTemplateMembersList()

public List<BreakTemplateMember> getBreakTemplateMembersList()

Optional. The list of the BreakTemplateMember objects in the order in which they should appear in the ad pod. Each BreakTemplateMember has a reference to an AdSpot, which defines what kinds of ads can appear at that position, as well as other metadata that defines how each ad spot should be filled.

repeated .google.ads.admanager.v1.BreakTemplateMember break_template_members = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<BreakTemplateMember>

getBreakTemplateMembersOrBuilder(int index)

public BreakTemplateMemberOrBuilder getBreakTemplateMembersOrBuilder(int index)

Optional. The list of the BreakTemplateMember objects in the order in which they should appear in the ad pod. Each BreakTemplateMember has a reference to an AdSpot, which defines what kinds of ads can appear at that position, as well as other metadata that defines how each ad spot should be filled.

repeated .google.ads.admanager.v1.BreakTemplateMember break_template_members = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
BreakTemplateMemberOrBuilder

getBreakTemplateMembersOrBuilderList()

public List<? extends BreakTemplateMemberOrBuilder> getBreakTemplateMembersOrBuilderList()

Optional. The list of the BreakTemplateMember objects in the order in which they should appear in the ad pod. Each BreakTemplateMember has a reference to an AdSpot, which defines what kinds of ads can appear at that position, as well as other metadata that defines how each ad spot should be filled.

repeated .google.ads.admanager.v1.BreakTemplateMember break_template_members = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.ads.admanager.v1.BreakTemplateMemberOrBuilder>

getCustomTemplate()

public boolean getCustomTemplate()

Optional. Whether this is a custom template. Custom templates get created outside of the ad rule workflow and can be referenced in ad tags. Only custom templates can have names and display names.

optional bool custom_template = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The customTemplate.

getDefaultInstanceForType()

public BreakTemplate getDefaultInstanceForType()

Returns
Type	Description
BreakTemplate

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public String getDisplayName()

Optional. Descriptive name for the BreakTemplate. This value is optional if customTemplate is true, and cannot be set otherwise.

optional string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. Descriptive name for the BreakTemplate. This value is optional if customTemplate is true, and cannot be set otherwise.

optional string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for displayName.

getFillOrderDirectionType()

public AdRuleFillOrderDirectionEnum.AdRuleFillOrderDirection getFillOrderDirectionType()

Optional. The fill order direction of the pod. This value is required if adBreakOptimizationType is equal to [AdBreakOptimizationType.POSITION][] and should otherwise be unset.

optional .google.ads.admanager.v1.AdRuleFillOrderDirectionEnum.AdRuleFillOrderDirection fill_order_direction_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AdRuleFillOrderDirectionEnum.AdRuleFillOrderDirection	The fillOrderDirectionType.

getFillOrderDirectionTypeValue()

public int getFillOrderDirectionTypeValue()

Optional. The fill order direction of the pod. This value is required if adBreakOptimizationType is equal to [AdBreakOptimizationType.POSITION][] and should otherwise be unset.

optional .google.ads.admanager.v1.AdRuleFillOrderDirectionEnum.AdRuleFillOrderDirection fill_order_direction_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for fillOrderDirectionType.

getName()

public String getName()

Identifier. The resource name of the BreakTemplate. Format: networks/{network_code}/breakTemplates/{break_template_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 BreakTemplate. Format: networks/{network_code}/breakTemplates/{break_template_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
ByteString	The bytes for name.

hasAdBreakOptimizationType()

public boolean hasAdBreakOptimizationType()

Optional. The optimization type of the pod. This field is optional and defaults to [AdBreakOptimizationType.REVENUE][].

optional .google.ads.admanager.v1.AdBreakOptimizationTypeEnum.AdBreakOptimizationType ad_break_optimization_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the adBreakOptimizationType field is set.

hasAdTagName()

public boolean hasAdTagName()

Optional. Name of the BreakTemplate. The name is case insensitive and can be referenced in ad tags. This value is required if customTemplate is true, and cannot be set otherwise. You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, ,, ~, ;, ^, (, ), <, >, [, ], the white space character.

optional string ad_tag_name = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the adTagName field is set.

hasCustomTemplate()

public boolean hasCustomTemplate()

Optional. Whether this is a custom template. Custom templates get created outside of the ad rule workflow and can be referenced in ad tags. Only custom templates can have names and display names.

optional bool custom_template = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the customTemplate field is set.

hasDisplayName()

public boolean hasDisplayName()

Optional. Descriptive name for the BreakTemplate. This value is optional if customTemplate is true, and cannot be set otherwise.

optional string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the displayName field is set.

hasFillOrderDirectionType()

public boolean hasFillOrderDirectionType()

Optional. The fill order direction of the pod. This value is required if adBreakOptimizationType is equal to [AdBreakOptimizationType.POSITION][] and should otherwise be unset.

optional .google.ads.admanager.v1.AdRuleFillOrderDirectionEnum.AdRuleFillOrderDirection fill_order_direction_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the fillOrderDirectionType field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(BreakTemplate other)

public BreakTemplate.Builder mergeFrom(BreakTemplate other)

Parameter
Name	Description
other	BreakTemplate

Returns
Type	Description
BreakTemplate.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BreakTemplate.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BreakTemplate.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public BreakTemplate.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
BreakTemplate.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

removeBreakTemplateMembers(int index)

public BreakTemplate.Builder removeBreakTemplateMembers(int index)

Optional. The list of the BreakTemplateMember objects in the order in which they should appear in the ad pod. Each BreakTemplateMember has a reference to an AdSpot, which defines what kinds of ads can appear at that position, as well as other metadata that defines how each ad spot should be filled.

repeated .google.ads.admanager.v1.BreakTemplateMember break_template_members = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
BreakTemplate.Builder

setAdBreakOptimizationType(AdBreakOptimizationTypeEnum.AdBreakOptimizationType value)

public BreakTemplate.Builder setAdBreakOptimizationType(AdBreakOptimizationTypeEnum.AdBreakOptimizationType value)

Optional. The optimization type of the pod. This field is optional and defaults to [AdBreakOptimizationType.REVENUE][].

optional .google.ads.admanager.v1.AdBreakOptimizationTypeEnum.AdBreakOptimizationType ad_break_optimization_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	AdBreakOptimizationTypeEnum.AdBreakOptimizationType The adBreakOptimizationType to set.

Returns
Type	Description
BreakTemplate.Builder	This builder for chaining.

setAdBreakOptimizationTypeValue(int value)

public BreakTemplate.Builder setAdBreakOptimizationTypeValue(int value)

Optional. The optimization type of the pod. This field is optional and defaults to [AdBreakOptimizationType.REVENUE][].

optional .google.ads.admanager.v1.AdBreakOptimizationTypeEnum.AdBreakOptimizationType ad_break_optimization_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The enum numeric value on the wire for adBreakOptimizationType to set.

Returns
Type	Description
BreakTemplate.Builder	This builder for chaining.

setAdTagName(String value)

public BreakTemplate.Builder setAdTagName(String value)

Optional. Name of the BreakTemplate. The name is case insensitive and can be referenced in ad tags. This value is required if customTemplate is true, and cannot be set otherwise. You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, ,, ~, ;, ^, (, ), <, >, [, ], the white space character.

optional string ad_tag_name = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The adTagName to set.

Returns
Type	Description
BreakTemplate.Builder	This builder for chaining.

setAdTagNameBytes(ByteString value)

public BreakTemplate.Builder setAdTagNameBytes(ByteString value)

Optional. Name of the BreakTemplate. The name is case insensitive and can be referenced in ad tags. This value is required if customTemplate is true, and cannot be set otherwise. You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, ,, ~, ;, ^, (, ), <, >, [, ], the white space character.

optional string ad_tag_name = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for adTagName to set.

Returns
Type	Description
BreakTemplate.Builder	This builder for chaining.

setBreakTemplateMembers(int index, BreakTemplateMember value)

public BreakTemplate.Builder setBreakTemplateMembers(int index, BreakTemplateMember value)

Optional. The list of the BreakTemplateMember objects in the order in which they should appear in the ad pod. Each BreakTemplateMember has a reference to an AdSpot, which defines what kinds of ads can appear at that position, as well as other metadata that defines how each ad spot should be filled.

repeated .google.ads.admanager.v1.BreakTemplateMember break_template_members = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	BreakTemplateMember

Returns
Type	Description
BreakTemplate.Builder

setBreakTemplateMembers(int index, BreakTemplateMember.Builder builderForValue)

public BreakTemplate.Builder setBreakTemplateMembers(int index, BreakTemplateMember.Builder builderForValue)

Optional. The list of the BreakTemplateMember objects in the order in which they should appear in the ad pod. Each BreakTemplateMember has a reference to an AdSpot, which defines what kinds of ads can appear at that position, as well as other metadata that defines how each ad spot should be filled.

repeated .google.ads.admanager.v1.BreakTemplateMember break_template_members = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	BreakTemplateMember.Builder

Returns
Type	Description
BreakTemplate.Builder

setCustomTemplate(boolean value)

public BreakTemplate.Builder setCustomTemplate(boolean value)

Optional. Whether this is a custom template. Custom templates get created outside of the ad rule workflow and can be referenced in ad tags. Only custom templates can have names and display names.

optional bool custom_template = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The customTemplate to set.

Returns
Type	Description
BreakTemplate.Builder	This builder for chaining.

setDisplayName(String value)

public BreakTemplate.Builder setDisplayName(String value)

Optional. Descriptive name for the BreakTemplate. This value is optional if customTemplate is true, and cannot be set otherwise.

optional string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The displayName to set.

Returns
Type	Description
BreakTemplate.Builder	This builder for chaining.

setDisplayNameBytes(ByteString value)

public BreakTemplate.Builder setDisplayNameBytes(ByteString value)

Optional. Descriptive name for the BreakTemplate. This value is optional if customTemplate is true, and cannot be set otherwise.

optional string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for displayName to set.

Returns
Type	Description
BreakTemplate.Builder	This builder for chaining.

setFillOrderDirectionType(AdRuleFillOrderDirectionEnum.AdRuleFillOrderDirection value)

public BreakTemplate.Builder setFillOrderDirectionType(AdRuleFillOrderDirectionEnum.AdRuleFillOrderDirection value)

Optional. The fill order direction of the pod. This value is required if adBreakOptimizationType is equal to [AdBreakOptimizationType.POSITION][] and should otherwise be unset.

optional .google.ads.admanager.v1.AdRuleFillOrderDirectionEnum.AdRuleFillOrderDirection fill_order_direction_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	AdRuleFillOrderDirectionEnum.AdRuleFillOrderDirection The fillOrderDirectionType to set.

Returns
Type	Description
BreakTemplate.Builder	This builder for chaining.

setFillOrderDirectionTypeValue(int value)

public BreakTemplate.Builder setFillOrderDirectionTypeValue(int value)

Optional. The fill order direction of the pod. This value is required if adBreakOptimizationType is equal to [AdBreakOptimizationType.POSITION][] and should otherwise be unset.

optional .google.ads.admanager.v1.AdRuleFillOrderDirectionEnum.AdRuleFillOrderDirection fill_order_direction_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The enum numeric value on the wire for fillOrderDirectionType to set.

Returns
Type	Description
BreakTemplate.Builder	This builder for chaining.

setName(String value)

public BreakTemplate.Builder setName(String value)

Identifier. The resource name of the BreakTemplate. Format: networks/{network_code}/breakTemplates/{break_template_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
BreakTemplate.Builder	This builder for chaining.

setNameBytes(ByteString value)

public BreakTemplate.Builder setNameBytes(ByteString value)

Identifier. The resource name of the BreakTemplate. Format: networks/{network_code}/breakTemplates/{break_template_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
BreakTemplate.Builder	This builder for chaining.