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

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

maxResults は 1 ページの結果数を保証するものではありません。レスポンスの nextPageToken フィールドが空でない場合は、結果が不完全であることを示します。次のページを取得するには、前のリクエストを繰り返し、前のページの nextPageToken の値を持つ pageToken パラメータを追加します。後続の各ページでは、レスポンスにすべての結果が含まれるまで、新しい nextPageToken が提供されます。

たとえば、次のクエリは最初のページをリクエストします。

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

レスポンスには nextPageToken が含まれます。

{
  "nextPageToken": "CiAKGjBpNDd2Nmp2Zml2cXRwYjBpOXA"
}

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

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