type UserPage (v202411)

  • The UserPage object retrieves a subset of User objects, providing navigation through a larger result set.

  • It includes details such as the total number of users (totalResultSetSize), the starting position of the current page (startIndex), and the actual user data (results).

  • Users are accessed using the getUsersByStatement() method within the UserService, and data is structured according to the specified namespace.
Service
UserService
Dependencies
getUsersByStatement()
▼
UserPage

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.