キャンペーンの最大数増加と、アカウントに関連付けられたすべてのエンティティの効率的な取得をサポートするため、広告主APIは多数のGETエンドポイントでページネーションをサポートします。ページングメカニズムは、使い方が簡単で、「カーソルを使用してコレクションをナビゲートする」で説明されるようにREST APIのカーソルベースのページネーションによく似ています。

はじめに

指定されたGETリクエストについて、cursorとcountのクエリパラメータを受け入れられるようになりました。パラメータは両方とも任意です。応答にcountを上回るエンティティがある場合、これらのエンドポイントは応答JSONで最初のcountエンティティと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": {...}
}

詳細

ほとんどのエンドポイントでは、count値の最大は1,000、最小は1、デフォルトは200になります。

next_cursorで返される値は常に文字列ですが、この点は不明瞭です。実装では変更される可能性があります。count未満のエンティティが結果セットの現在のページで返される場合、next_cursor値はnullになります。

注: アナリティクスエンドポイントでは、このページネーションスタイルはサポートしません。統計エンドポイントのページングは、指定期間サポートされます。詳細については個別のエンドポイントのドキュメントを参照してください。