type BreakTemplatePage (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
Captures a page of BreakTemplate objects.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202408
Field
|
totalResultSetSize
|
xsd:int
The size of the total result set to which this page belongs.
|
startIndex
|
xsd:int
The absolute index in the total result set on which this page begins.
|
results
|
BreakTemplate[]
The collection of break templates contained within this page.
|
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-06 UTC.
[null,null,["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eAdRuleService's getBreakTemplatesByStatement() method returns a BreakTemplatePage object.\u003c/p\u003e\n"],["\u003cp\u003eBreakTemplatePage objects contain information about a page of BreakTemplate objects, including the total result size, starting index, and the break templates themselves.\u003c/p\u003e\n"],["\u003cp\u003eThe BreakTemplatePage object uses the namespace \u003ccode\u003ehttps://www.google.com/apis/ads/publisher/v202408\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eWithin a BreakTemplatePage, the \u003ccode\u003etotalResultSetSize\u003c/code\u003e and \u003ccode\u003estartIndex\u003c/code\u003e fields provide information about the position and size of the page within the full result set, while \u003ccode\u003eresults\u003c/code\u003e contains the actual BreakTemplate objects.\u003c/p\u003e\n"]]],["The `AdRuleService` utilizes the `getBreakTemplatesByStatement()` method to retrieve a `BreakTemplatePage`. This page contains a collection of `BreakTemplate` objects. The `BreakTemplatePage` provides information including `totalResultSetSize`, representing the total number of results, `startIndex`, indicating the page's starting position in the result set, and `results`, which is the array of retrieved break templates. The service operates within the `https://www.google.com/apis/ads/publisher/v202408` namespace.\n"],null,["# type BreakTemplatePage (v202408)\n\n**Service** \n**AdRuleService** **Dependencies** \n[getBreakTemplatesByStatement()](/ad-manager/api/reference/v202408/AdRuleService#getBreakTemplatesByStatement) \n▼\n**BreakTemplatePage**\n\nCaptures a page of [BreakTemplate](/ad-manager/api/reference/v202408/AdRuleService.BreakTemplate) objects.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202408`\n\n| Field ----- ||\n|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `totalResultSetSize` | ` `xsd:`int` The size of the total result set to which this page belongs. |\n| ### `startIndex` | ` `xsd:`int` The absolute index in the total result set on which this page begins. |\n| ### `results` | ` `[BreakTemplate](/ad-manager/api/reference/v202408/AdRuleService.BreakTemplate)`[]` The collection of break templates contained within this page. |"]]