maxResults
フィールドを設定することで、リスト リクエストに対するレスポンスでサーバーが返すリソースの最大数を制御できます。また、一部のコレクション(Events など)では、サーバーが取得するエントリ数に上限が設定されており、この上限を超えることはありません。イベントの総数がこの最大値を超えると、サーバーは結果の 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