Interface BreakTemplateOrBuilder (0.58.0) 

public interface BreakTemplateOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdBreakOptimizationType()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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

getBreakTemplateMembersCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getDisplayName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.