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/v202408
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eA BreakTemplate dictates the types and positions of ads within an ad pod, utilizing AdSpot objects for configuration.\u003c/p\u003e\n"],["\u003cp\u003eBreakTemplates must contain one flexible AdSpot and can be custom-made outside the ad rule workflow.\u003c/p\u003e\n"],["\u003cp\u003eCustom BreakTemplates can be named and referenced in ad tags for external use.\u003c/p\u003e\n"],["\u003cp\u003eEach BreakTemplate includes BreakTemplateMember objects that arrange AdSpots in the desired ad pod sequence.\u003c/p\u003e\n"],["\u003cp\u003eEssential properties of a BreakTemplate include its ID, custom status, name, display name, and member configuration.\u003c/p\u003e\n"]]],["The `BreakTemplate` defines ad types and positions within a pod, consisting of `AdSpot` objects. It must include one flexible `AdSpot`. Key fields include `id` (read-only), `customTemplate` (boolean), `name` (required for custom templates), `displayName` (optional for custom templates), and `breakTemplateMembers` (ordered list of `AdSpot` references). AdRuleService manages BreakTemplates, with functions to create and update. Custom templates are created externally and can be referenced in ad tags.\n"],null,["# type BreakTemplate (v202408)\n\n**Service** \n**AdRuleService** **Dependencies** \n[BreakTemplatePage](/ad-manager/api/reference/v202408/AdRuleService.BreakTemplatePage) [createBreakTemplates()](/ad-manager/api/reference/v202408/AdRuleService#createBreakTemplates) [updateBreakTemplates()](/ad-manager/api/reference/v202408/AdRuleService#updateBreakTemplates) \n▼\n**BreakTemplate**\n\n\nA [BreakTemplate](/ad-manager/api/reference/v202408/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/v202408/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/v202408`\n\n| Field ----- ||\n|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `id` | ` `xsd:`long` The unique ID of the [BreakTemplate](/ad-manager/api/reference/v202408/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/v202408/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/v202408/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/v202408/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. |"]]
