リスト リクエストに対するレスポンスでサーバーが返すリソースの最大数を制御するには、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