ページネーション

より多くのキャンペーン上限に対応し、アカウントに関連するすべてのエンティティを効率的に取得できるよう、Advertiser API は多くの GET エンドポイントでページネーションをサポートするようになりました。ページングの仕組みは使いやすく、Using cursors to navigate collections で説明されている REST API のカーソルベースのページネーションと非常に似ています。

​

はじめに

一部の指定された GET リクエストで、任意のクエリパラメータである cursor と count を受け付けるようになりました。レスポンスのエンティティ数が count を超える場合、これらのエンドポイントは最初の 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": {...}
}

​

さらに詳しく

ほとんどのエンドポイントでは、count の最大値は1,000、最小値は1、既定値は200です。

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

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