PageInfo
Stay organized with collections
Save and categorize content based on your preferences.
Information about the current page.
List operations that supports paging return only one "page" of results. This protocol buffer message describes the page that has been returned.
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-05-21 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-21 UTC."],[[["\u003cp\u003eThis documentation details the structure of a JSON response for paginated API results.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes the total number of results, the number of results per page, and the starting index of the current page.\u003c/p\u003e\n"],["\u003cp\u003eThis information is used to navigate through large datasets by displaying results in manageable chunks.\u003c/p\u003e\n"]]],["The document defines the structure of a page of results returned from an API. It uses a JSON representation with three fields: `totalResults` indicates the total number of results available; `resultPerPage` specifies the maximum results returned per page; and `startIndex` denotes the index of the first result on the current page. These fields allow clients to navigate through large result sets by requesting specific pages.\n"],null,["# PageInfo\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nInformation about the current page.\n\nList operations that supports paging return only one \"page\" of results. This protocol buffer message describes the page that has been returned.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------|\n| ``` { \"totalResults\": integer, \"resultPerPage\": integer, \"startIndex\": integer } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------|\n| `totalResults` | `integer` Total number of results available on the backend ! The total number of results in the result set. |\n| `resultPerPage` | `integer` Maximum number of results returned in one page. ! The number of results included in the API response. |\n| `startIndex` | `integer` Index of the first result returned in the current page. |"]]
