Class BreakTemplate

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.

Inheritance
object
BreakTemplate
Implements
Inherited Members
Namespace: Google.Ads.AdManager.V1
Assembly: Google.Ads.AdManager.V1.dll
public sealed class BreakTemplate : IMessage<BreakTemplate>, IEquatable<BreakTemplate>, IDeepCloneable<BreakTemplate>, IBufferMessage, IMessage

Constructors

Declaration
public BreakTemplate()
Declaration
public BreakTemplate(BreakTemplate other)
Parameters
Type Name Description
BreakTemplate other

Properties

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

Declaration
public AdBreakOptimizationTypeEnum.Types.AdBreakOptimizationType AdBreakOptimizationType { get; set; }
Property Value
Type Description
AdBreakOptimizationTypeEnum.Types.AdBreakOptimizationType

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.

Declaration
public string AdTagName { get; set; }
Property Value
Type Description
string

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.

Declaration
public RepeatedField<BreakTemplateMember> BreakTemplateMembers { get; }
Property Value
Type Description
RepeatedField<BreakTemplateMember>

BreakTemplateName-typed view over the Name resource name property.

Declaration
public BreakTemplateName BreakTemplateName { get; set; }
Property Value
Type Description
BreakTemplateName

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.

Declaration
public bool CustomTemplate { get; set; }
Property Value
Type Description
bool

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

Declaration
public string DisplayName { get; set; }
Property Value
Type Description
string

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

Declaration
public AdRuleFillOrderDirectionEnum.Types.AdRuleFillOrderDirection FillOrderDirectionType { get; set; }
Property Value
Type Description
AdRuleFillOrderDirectionEnum.Types.AdRuleFillOrderDirection

Gets whether the "ad_break_optimization_type" field is set

Declaration
public bool HasAdBreakOptimizationType { get; }
Property Value
Type Description
bool

Gets whether the "ad_tag_name" field is set

Declaration
public bool HasAdTagName { get; }
Property Value
Type Description
bool

Gets whether the "custom_template" field is set

Declaration
public bool HasCustomTemplate { get; }
Property Value
Type Description
bool

Gets whether the "display_name" field is set

Declaration
public bool HasDisplayName { get; }
Property Value
Type Description
bool

Gets whether the "fill_order_direction_type" field is set

Declaration
public bool HasFillOrderDirectionType { get; }
Property Value
Type Description
bool

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

Declaration
public string Name { get; set; }
Property Value
Type Description
string