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

​
はじめに

対応する GET リクエストでは、cursor と count の 2 つのクエリパラメーターを受け付けます(いずれも任意)。レスポンスに count を超えるエンティティが含まれる場合、これらのエンドポイントは最初の count 件のエンティティと、レスポンス JSON の next_cursor キーを返します。 GET https://ads-api.x.com/5/accounts/abc1/campaigns?count=50
次のレスポンス群を取得するには、クエリパラメーターに cursor を追加します。 GET https://ads-api.x.com/5/accounts/abc1/campaigns?cursor=c-3yvu1pzhd3i7&count=50

​
より詳しく

多くのエンドポイントで、count の最大値は 1,000、最小値は 1、デフォルトは 200 です。 next_cursor の値は常に文字列であり、不透明(opaque)なものとして扱ってください。実装は変更される可能性があります。現在のページに返されるエンティティの数が count より少ない場合、next_cursor の値は null になります。 注: analytics エンドポイントはこのスタイルのページネーションをサポートしません。統計エンドポイントでのページ送りは、期間を指定することでサポートされます。詳細は、それぞれのエンドポイントのドキュメントを参照してください。