type BreakTemplate (v202411)

  • A BreakTemplate dictates the types and positions of ads within an ad pod, utilizing AdSpot objects for configuration.

  • BreakTemplates must contain one flexible AdSpot and can be custom-made outside the ad rule workflow.

  • Custom BreakTemplates can be named and referenced in ad tags for external use.

  • Each BreakTemplate includes a series of BreakTemplateMembers, ordered to specify ad appearance within the ad pod.

  • BreakTemplateMembers reference AdSpots, controlling ad types and fill behavior for each position.
Service
AdRuleService
Dependencies
BreakTemplatePage createBreakTemplates() updateBreakTemplates()
▼
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 AdSpot#flexible set to true.

Namespace
https://www.google.com/apis/ads/publisher/v202411

Field

id

xsd:long

The unique ID of the BreakTemplate. This value is readonly and is assigned by Google.

customTemplate

xsd:boolean

Whether this is 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.

name

xsd:string

Name of the BreakTemplate. The name is case insenstive 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.

displayName

xsd:string

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

breakTemplateMembers

BreakTemplate.BreakTemplate...[]

The list of the BreakTemplateMember objects in the order in which they should appear in the ad pod. Each BreakTemplateMember has a reference to a 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.