リソースのリストを返す GET ベースのすべてのエンドポイントは、カーソルベースのページネーションをサポートしています。デフォルトでは、結果は新しいものから降順で返されます。
クエリパラメーター
- maxResults整数
- 返すオブジェクトの数です。設定されていない場合、デフォルトでは20です。サポートされている最大値は100です。
- pageToken文字列
- リクエストするページへのカーソルです。リクエストにより、ページごとにオブジェクトを反復処理できるよう現在と次のページのトークンを返します。
レスポンス
- object文字列 (値は collection)
- オブジェクトの種類を表す文字列です。同じ種類のオブジェクトの場合は同じ値を共有します。
- pageToken文字列
- リクエストするページへのカーソルです。リクエストにより、ページごとにオブジェクトを反復処理できるよう現在と次のページのトークンを返します。
- nextPageToken文字列
- 次のページへのカーソルです。このトークンを使って次のオブジェクトセットをリクエストすることができます。このカーソルがない場合、それ以上返すオブジェクトがないということです。
- maxResults整数
- 呼び出しにより返されるオブジェクトの最大数です。指定された maxResults クエリパラメーターと同じ値です(指定されていない場合は20)。
- results整数
- 呼び出しで実際に返されたオブジェクトの数です。この値はmaxResults と同じまたはそれ以下になります。
- data配列
- リクエストにより返されるオブジェクトの配列です。