Skip to main content
オフセットベースのページ割りを使用するAPIは、offsetおよびlimitクエリパラメータを使用してコレクション内の項目のページ割りを行います。 オフセットベースのページネーションは、項目のリストがあらかじめ決められた固定長の場合によく使用されます。

ページング

コレクション内のエントリの最初のページを取得するには、APIをoffsetパラメータを指定せずに呼び出すか、offset0に設定して呼び出す必要があります。limitフィールドは省略可能です。
エントリの次のページを取得するには、以前のoffset値と以前の結果で返された制限の合計 (previous_offset + previous_limit) と等しいoffsetパラメータを指定して、APIを呼び出す必要があります。
offsetは、レスポンス配列内のエントリのサイズではなく、以前のlimit分だけ加算されますので注意してください。これは制限を下回る可能性があるためです。一般的には、レスポンスオブジェクトのlimitの値を使用してoffset値を加算することをお勧めします。
次のoffset値がレスポンスオブジェクト内のtotal_count値を超えている場合、項目の最終ページはリクエスト済みです。この時点では、これ以上取得する項目がありません。

オフセットと制限

以下のクエリパラメータは、コレクションのページネーションに使用されます。
オフセットベースのページネーションの最大offset9999です。さらに大きいオフセットが必要な場合はマーカーベースのページネーションをお勧めします。

コレクション

コレクションのページネーションを行うと、APIによって、結果のセットを配列として含むオブジェクトのほか、結果の現在のページに関する情報が返されます。

エンドポイントの例

以下は、オフセットベースのページネーションをサポートするエンドポイントの例です。
最終更新日 2026年4月15日