type OrderPage (v202405)
Captures a page of Order objects.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202405
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
|
Order[]
The collection of orders 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 2024-05-15 UTC.
[null,null,["Last updated 2024-05-15 UTC."],[[["`OrderPage` objects represent a page within a larger set of `Order` objects, providing access to a subset of orders."],["The `OrderPage` structure includes the total number of orders (`totalResultSetSize`), the starting position of the current page (`startIndex`), and the actual `Order` objects on that page (`results`)."],["This object is used when retrieving orders through the `getOrdersByStatement()` method of the `OrderService`, facilitating navigation and management of large order sets."]]],["The `OrderService` utilizes the `getOrdersByStatement()` method to retrieve a paginated collection of `Order` objects, represented by `OrderPage`. This page contains the `results` field, an array of orders. Additional fields include `totalResultSetSize`, indicating the total number of orders, and `startIndex`, which specifies the page's starting index within the entire result set. All of these elements are defined within the namespace `https://www.google.com/apis/ads/publisher/v202405`.\n"]]