ページネーション

アカウントに関連付けられたキャンペーンの最大数の拡張と、すべてのエンティティの効率的な取得を可能にするため、Advertiser API は多数の GET endpoint でページネーションをサポートするようになりました。ページングの仕組みは簡単で、Using cursors to navigate collections で説明されている REST API のカーソルベースのページネーションと非常に似ています。

​

はじめに

特定の GET リクエストで、cursor と count の query パラメータを受け付けるようになりました。いずれも任意です。レスポンスに含まれるエンティティが count を超える場合、これらの endpoint は先頭の count 件のエンティティと、レスポンスの JSON に next_cursor キーを含めて返します。

GET https://ads-api.x.com/5/accounts/abc1/campaigns?count=50

{
  "data": \[...\],
  "next_cursor": "c-3yvu1pzhd3i7",
  "request": {...}
}

次の一連のレスポンスを取得するには、クエリパラメータに cursor を追加します:

GET https://ads-api.x.com/5/accounts/abc1/campaigns?cursor=c-3yvu1pzhd3i7&count=50

{
  "data": \[...\],
  "next_cursor": "c-3w3zdyg8ywan",
  "request": {...}
}

​

さらに詳しく

ほとんどの endpoint において、count の最大値は 1,000、最小値は 1、既定値は 200 です。

next_cursor が返す値は常に文字列であり、不透明なものとして扱う必要があります。実装は将来的に変更される可能性があります。結果セットの現在のページで返されるエンティティが count 未満の場合、next_cursor の値は null になります。

注: analytics endpoint はこの方式のページネーションをサポートしていません。stats endpoint でのページングは、期間を指定することで行います。詳細は各 endpoint のドキュメントを参照してください。