メインコンテンツへスキップ
Advertiser API は、こちらに記載のとおり REST API v1.1 と同様の方法でレート制限されています: REST API Rate Limiting in v1.1。REST API v1.1 と異なり、endpoint ごとの制限についてのプログラムによる索引は提供されていません。endpoint のレートリミットとリセットウィンドウは、HTTP レスポンスヘッダーで通知されます。X Ads API におけるすべてのレートリミットは OAuth 1.0a を使用します。

ユーザーレベルおよび広告アカウントレベルの制限

レートリミットには2種類あります。ユーザートークンレベルと広告アカウントレベルです。endpoint の一部は、広告アカウントレベルのレートリミットに対応しています。ユーザートークンは、X Ads API を認証して呼び出すために使用する OAuth access token です。各ユーザートークンは、1つ以上の広告アカウントにアクセスできます。 レスポンスヘッダーに広告アカウントレベルのレートリミットが返される場合はそれを使用し、広告アカウントの制限が見つからない場合にのみユーザーレベルの制限を使用してください。 ユーザーレベルのレートリミットは、次のヘッダーで示されます: x-rate-limit-limitx-rate-limit-remainingx-rate-limit-reset 広告アカウントレベルのレートリミットに対応している endpoint では、レートリミットは次のヘッダーで示されます: x-account-rate-limit-limitx-account-rate-limit-remainingx-account-rate-limit-reset 広告アカウントレベルのレートリミットは、アプリケーションがエンティティの data(キャンペーンやラインアイテムなどのオブジェクト)を、複数の広告アカウントにアクセスする単一のユーザートークンから同期できるように、GET endpoint に対してのみ提供されます。書き込みアクションが同じ広告アカウントレベルのレートリミットを使用することは保証されません。 広告アカウントレベルでレートリミットが適用される endpoint の場合、ユーザーレベルのレートリミットは、アプリケーション全体のグローバルクォータを表す高い値に設定されます。利用可能な場合は、リクエスト量の制御において広告アカウントレベルのレートリミットを優先してください。

ベストプラクティス

  1. データベースに最後に同期したタイムスタンプを保存し、該当する場合は sort_by=updated_at-desc オプションを付けてデータをリクエストすることで、最後に同期したタイムスタンプより古いデータに達した時点で同期処理を停止できるようにします。これにより、同じデータの重複同期を回避できます。
  2. 1 回のリクエストで複数のエンティティを取得する: 一部の endpoint では、カンマ区切りの値リストを指定して、類似データをまとめて取得できます。これにより、総リクエスト数を削減し、レートリミットをより効率的に活用できます。
  3. リクエストでは「count」の最大値を指定する: GET accounts/:account_id/targeting_criteria などの endpoint では、デフォルトの 200 ではなく 1000 個のオブジェクトを返すため、count の最大値で呼び出すことを強く推奨します。

アナリティクスの同期

アナリティクスのendpointにおけるレートリミットの詳細は、Analytics Rate Limiting Guideをご参照ください。

よくある質問

特定の広告アカウントまたは当社のアプリケーションのレートリミットを増やすことは可能ですか? 一般的にレートリミットを引き上げることはできず、最大規模の広告アカウントを支える水準に設定されています。まずは本ドキュメントに記載のベストプラクティスを実装してください。それでもレートリミットがスケールやビジネス目標の達成に影響する場合は、ユースケースおよび関連するリクエストの詳細を添えて、X Ads API の担当窓口までご連絡ください。

レートリミットのスコープ

このドキュメントにおけるスコープ

  • Category: 指定されたカテゴリに属するすべての endpoint は、各ウィンドウにつき単一の割り当て上限内でレートリミットの対象となります。
  • Endpoint: 各 endpoint には、各ウィンドウごとに個別の割り当て上限が設定されています。

X Ads API レートリミット一覧

X Ads API のレートリミット

endpoint の種類endpoint またはカテゴリ単位のスコープ1分間ウィンドウあたりのレートリミット
書き込み (POST, PUT, DELETE)カテゴリ450
オーディエンスendpoint1500
endpoint の種類endpoint またはカテゴリ単位のスコープ15分間ウィンドウあたりのレートリミット
分析 (同期)カテゴリ250
コアエンティティの読み取り (Line Items、Campaigns など)

その他のアカウントの読み取り (:account_id を含むその他の GET endpoint)
endpoint (広告アカウントレベル)

endpoint (広告アカウントの一部レベル)
10,000

2000
ターゲティング条件 (下記以外)カテゴリ400
ターゲティング条件 (tv_markets、tv_shows)endpoint2000
オーディエンスインサイトカテゴリ400
キーワードインサイトカテゴリ500
グローバル読み取り (:account_id を含まない GET endpoint)endpoint5
コンバージョンendpoint60,000
I