ページネーション

1 つのアカウントに紐づくキャンペーン数の上限を拡大し、アカウントに関連するすべてのエンティティを効率的に取得できるようにするため、Advertiser API では現在、多くの GET エンドポイントでページネーションをサポートしています。ページングの仕組みは使いやすく、カーソルを使用してコレクションを移動する で説明されている 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 エンドポイントでのページングは、期間を指定することでサポートされます。詳しくは、それぞれのエンドポイントのドキュメントを参照してください。