Skip to main content
API のレスポンスに一度に返せる以上の結果が含まれる場合、ページネーションを使用してすべてのページのデータを取得します。

ページネーションの仕組み

  1. max_results を指定して初回リクエストを行う
  2. レスポンスの meta オブジェクトに next_token があるか確認
  3. 存在する場合、そのトークンを pagination_token として次のリクエストを行う
  4. next_token が返されなくなるまで繰り返す

ページネーショントークン


レスポンスの構造

これ以上結果がない場合、next_token は省略されます。

ページネーションパラメータ

具体的な max_results の上限については、各エンドポイントの API リファレンスを確認してください。

例: すべての結果をページネーションで取得

Example

ベストプラクティス

max results を活用

API 呼び出しを最小化するため、許容される最大の max_results をリクエストしてください。

部分ページに対応

最後のページは max_results より結果が少ないことがあります。

トークンを保存

後でページネーションを再開する必要がある場合は next_token を保存してください。

ページネーションでポーリングしない

新しいデータを取得するには、繰り返しページ送りするのではなく since_id を使用してください。

結果の順序

結果は 新しい順(逆時系列) で返されます。
  • 最初のページの最初の結果 = 最新
  • 最後のページの最後の結果 = 最古
これはページ内およびページ間で適用されます。

注意事項

  • ページネーショントークンは不透明な文字列であり、パースや変更を行わないでください
  • トークンは一定時間で失効することがあります
  • max_results より少ない結果を受け取っても、まだ結果が存在する可能性があります(next_token がなくなるまで続けてください)
  • 自動ページネーション処理には SDK を使用してください

次のステップ

Rate limits

ページネーション時のリクエスト制限を理解する。

SDK

ページネーションが組み込まれたライブラリ。