リソースの一覧を順番に確認する

maxResults フィールドを設定することで、リスト リクエストへのレスポンスでサーバーが返すリソースの最大数を制御できます。さらに、一部のコレクション(イベントなど)では、取得するエントリの数にハードリミットがあり、サーバーがその上限を超えることはありません。イベントの合計数がこの上限を超えると、サーバーから 1 ページの結果が返されます。

maxResults では、1 ページに表示される結果の数を保証できません。結果が不完全であるかどうかは、結果の nextPageToken フィールドが空でないことを確認することで判断できます。次のページを取得するには、前回とまったく同じリクエストを実行し、前のページの nextPageToken の値を持つ pageToken フィールドを追加します。すべての結果が取得されるまで、次のページに新しい nextPageToken が提供されます。

たとえば、次のクエリは、ページ分けされたリストの次のページの結果を取得するクエリです。

GET /calendars/primary/events?maxResults=10&singleEvents=true

//Result contains

"nextPageToken":"CiAKGjBpNDd2Nmp2Zml2cXRwYjBpOXA",

後続のクエリは、nextPageToken の値を取得し、pageToken の値として送信します。

GET /calendars/primary/events?maxResults=10&singleEvents=true&pageToken=CiAKGjBpNDd2Nmp2Zml2cXRwYjBpOXA