type BreakTemplate (v202508)
Stay organized with collections
Save and categorize content based on your preferences.
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/v202508
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-13 UTC.
[null,null,["Last updated 2025-08-13 UTC."],[],[],null,["# type BreakTemplate (v202508)\n\n**Service** \n**AdRuleService** **Dependencies** \n[BreakTemplatePage](/ad-manager/api/reference/v202508/AdRuleService.BreakTemplatePage) [createBreakTemplates()](/ad-manager/api/reference/v202508/AdRuleService#createBreakTemplates) [updateBreakTemplates()](/ad-manager/api/reference/v202508/AdRuleService#updateBreakTemplates) \n▼\n**BreakTemplate**\n\n\nA [BreakTemplate](/ad-manager/api/reference/v202508/AdRuleService.BreakTemplate) defines what kinds of ads show at which\npositions within a pod.\n\nBreak templates are made up of [AdSpot](/ad-manager/api/reference/v202508/AdRuleService.AdSpot) objects. A break template must\nhave a single ad spot that has `AdSpot#flexible` set to true.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202508`\n\n| Field ----- ||\n|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `id` | ` `xsd:`long` The unique ID of the [BreakTemplate](/ad-manager/api/reference/v202508/AdRuleService.BreakTemplate). This value is readonly and is assigned by Google. |\n| ### `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. \u003cbr /\u003e |\n| ### `name` | ` `xsd:`string` Name of the [BreakTemplate](/ad-manager/api/reference/v202508/AdRuleService.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: \", ', =, !, +, #, \\*, \\~, ;, \\^, (, ), \\\u003c, \\\u003e, \\[, \\], the white space character. \u003cbr /\u003e |\n| ### `displayName` | ` `xsd:`string` Descriptive name for the `BreakTemplateDto`. This value is optional if `customTemplate` is true, and cannot be set otherwise. |\n| ### `breakTemplateMembers` | ` `[BreakTemplate.BreakTemplate...](/ad-manager/api/reference/v202508/AdRuleService.BreakTemplate.BreakTemplateMember \"BreakTemplate.BreakTemplateMember\")`[]` 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](/ad-manager/api/reference/v202508/AdRuleService.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. |"]]
