type AudienceSegmentPage (v202411)
Stay organized with collections
Save and categorize content based on your preferences.
Service
AudienceSegmentService
Represents a page of AudienceSegment objects.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202411
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\u003e\u003ccode\u003eAudienceSegmentPage\u003c/code\u003e represents a page of \u003ccode\u003eAudienceSegment\u003c/code\u003e objects, providing access to a subset of audience segments within a larger result set.\u003c/p\u003e\n"],["\u003cp\u003eIt includes information about the total result set size (\u003ccode\u003etotalResultSetSize\u003c/code\u003e) and the starting position of the current page within that set (\u003ccode\u003estartIndex\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eresults\u003c/code\u003e field contains an array of \u003ccode\u003eAudienceSegment\u003c/code\u003e objects, which can be of various types like \u003ccode\u003eFirstPartyAudienceSegment\u003c/code\u003e, \u003ccode\u003eThirdPartyAudienceSegment\u003c/code\u003e, and others, representing the segments on this page.\u003c/p\u003e\n"],["\u003cp\u003eThis page is accessed through the \u003ccode\u003eAudienceSegmentService\u003c/code\u003e, specifically the \u003ccode\u003egetAudienceSegmentsByStatement\u003c/code\u003e method, which allows retrieval of audience segments based on specified criteria.\u003c/p\u003e\n"]]],["The `AudienceSegmentService` uses `getAudienceSegmentsByStatement` to retrieve a page of `AudienceSegment` objects. An `AudienceSegmentPage` contains `totalResultSetSize`, indicating the total number of results, and `startIndex`, the page's starting index. The `results` field holds an array of different `AudienceSegment` types, including `FirstPartyAudienceSegment`, `ThirdPartyAudienceSegment`, and `SharedAudienceSegment`. This page represents a subset of the complete audience segment data.\n"],null,["# type AudienceSegmentPage (v202411)\n\n**Service** \n**AudienceSegmentService** **Dependencies** \n[getAudienceSegmentsByStatem...](/ad-manager/api/reference/v202411/AudienceSegmentService#getAudienceSegmentsByStatement \"getAudienceSegmentsByStatement()\") \n▼\n**AudienceSegmentPage**\n\nRepresents a page of [AudienceSegment](/ad-manager/api/reference/v202411/AudienceSegmentService.AudienceSegment) objects.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202411`\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` | 1. ` `[AudienceSegment](/ad-manager/api/reference/v202411/AudienceSegmentService.AudienceSegment)`[]` 1. ` `[FirstPartyAudienceSegment](/ad-manager/api/reference/v202411/AudienceSegmentService.FirstPartyAudienceSegment)` ` 1. ` `[NonRuleBasedFirstPartyAudie...](/ad-manager/api/reference/v202411/AudienceSegmentService.NonRuleBasedFirstPartyAudienceSegment \"NonRuleBasedFirstPartyAudienceSegment\")` ` 2. ` `[RuleBasedFirstPartyAudience...](/ad-manager/api/reference/v202411/AudienceSegmentService.RuleBasedFirstPartyAudienceSegmentSummary \"RuleBasedFirstPartyAudienceSegmentSummary\")` ` 1. ` `[RuleBasedFirstPartyAudience...](/ad-manager/api/reference/v202411/AudienceSegmentService.RuleBasedFirstPartyAudienceSegment \"RuleBasedFirstPartyAudienceSegment\")` ` 2. ` `[ThirdPartyAudienceSegment](/ad-manager/api/reference/v202411/AudienceSegmentService.ThirdPartyAudienceSegment)` ` 3. ` `[SharedAudienceSegment](/ad-manager/api/reference/v202411/AudienceSegmentService.SharedAudienceSegment)` ` \u003cbr /\u003e The collection of audience segments contained within this page. |"]]