maxResults
フィールドを設定すると、リスト リクエストに対するレスポンスでサーバーが返すリソースの最大数を制御できます。さらに、一部のコレクション(イベントなど)では、取得されるエントリの数にハードリミットがあり、サーバーがその数を超えることはありません。イベントの合計数がこの最大値を超えると、サーバーは 1 ページの結果を返します。
maxResults
を使用しても、1 ページに表示する結果数が保証されるわけではありません。不完全な結果は、結果で空でない nextPageToken
フィールドによって検出できます。次のページを取得するには、以前とまったく同じリクエストを実行し、pageToken
フィールドに前のページの nextPageToken
の値を追加します。すべての結果を取得するまで、次のページで新しい 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