type UserPage (v202411)
Stay organized with collections
Save and categorize content based on your preferences.
Captures a page of User objects
- Namespace
-
https://www.google.com/apis/ads/publisher/v202411
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
|
User[]
The collection of users 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\u003eThe \u003ccode\u003eUserPage\u003c/code\u003e object retrieves a subset of \u003ccode\u003eUser\u003c/code\u003e objects, providing navigation through a larger result set.\u003c/p\u003e\n"],["\u003cp\u003eIt includes details such as the total number of users (\u003ccode\u003etotalResultSetSize\u003c/code\u003e), the starting position of the current page (\u003ccode\u003estartIndex\u003c/code\u003e), and the actual user data (\u003ccode\u003eresults\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eUsers are accessed using the \u003ccode\u003egetUsersByStatement()\u003c/code\u003e method within the \u003ccode\u003eUserService\u003c/code\u003e, and data is structured according to the specified namespace.\u003c/p\u003e\n"]]],["The `UserService` allows retrieving users via `getUsersByStatement()`, returning a `UserPage`. A `UserPage` contains a collection of `User` objects (`results`), the total number of users (`totalResultSetSize`), and the starting index of the current page (`startIndex`). This is in the namespace `https://www.google.com/apis/ads/publisher/v202411`. The fields present in `UserPage` are for managing the pagination of large result sets.\n"],null,["# type UserPage (v202411)\n\n**Service** \n**UserService** **Dependencies** \n[getUsersByStatement()](/ad-manager/api/reference/v202411/UserService#getUsersByStatement) \n▼\n**UserPage**\n\nCaptures a page of [User](/ad-manager/api/reference/v202411/UserService.User) 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` | ` `[User](/ad-manager/api/reference/v202411/UserService.User)`[]` The collection of users contained within this page. |"]]
