メインコンテンツへスキップ

​
X Ads API へのアクセス方法

  1. デベロッパーアカウントに登録します。
  2. 開発者用 Appを作成し、トークンを安全に保管します。
  3. ads.x.com/help にアクセスし、各開発者用 App ごとに Ads API へのアクセス申請を行います。
注: 既に X Developer Platform を利用しており、デベロッパーアカウントをお持ちの場合は、手順 3 に進んでください。

​
ステップ1：デベロッパーアカウントに登録する

X の API 製品にリクエストを送信するには、まずデベロッパーアカウントに登録する必要があります。developer portal 内で Project と開発者用 App を作成します。これにより、API へのすべてのリクエストを認証するために使用する認証情報一式が付与されます。

​
ステップ2: App のキーおよびトークンを保存し、安全に管理する

開発者用 App では、API Key（Consumer Key とも呼ばれます）のセットが提供されます。個人の X アカウントに代わってリクエストを実行できる Access Tokens のセットや、OAuth 2.0 Bearer Token を要する endpoint の認証に使用できる Bearer Token を生成することもできます。これらのキーおよびトークンは再生成しない限り失効しないため、環境変数を用意するか、信頼できるパスワードマネージャーを使用することを推奨します。 また、App の詳細ページの URL に記載されている App ID も控えておいてください。これは次のステップで X Ads API へのアクセス申請を行う際に役立ちます。
注: キーおよびトークンは developer portal で一度しか表示されません。生成後ただちにパスワード管理システムに保管することが重要です。キーおよびトークンを紛失または失念した場合は再生成が必要になり、新しいキーおよびトークンが作成され、旧来のものは無効化されます。これにより、以前の資格情報で構成していたあらゆる連携を更新する必要があります。認証のベストプラクティスの詳細をご確認ください。

​
ステップ3: X Ads API へのアクセスを申請する

この時点では、X API への基本アクセスはありますが、X Ads API 固有の機能にはアクセスできません。次に、Ads API へのアクセスを申請し、承認を受ける必要があります。各 開発者用 App ごとに Ads API アクセスを申請するには、ads.x.com/help にアクセスしてください。

​
アクセスレベル

申請プロセスの一環として、必要なアクセスレベルを指定する必要があります。詳細は、App レベルおよび広告アカウントレベルの権限をご参照ください。

​
Conversion Only

モバイルおよびウェブの Conversion endpoint への読み取り・書き込みアクセス権。

​
Standard Access

Analytics、Campaign Management、Creatives、Custom Audiences、Conversion の各 endpoint に対する読み取り・書き込みアクセス。
注: App が X Ads API のアクセス承認を受けた後は、認証済みの Ads API リクエストを正しく行うために、ユーザー access token を再生成する必要があります。
注: 2023年7月以前にアクセスを申請した Ads API 開発者は、アクセスレベルや権限が異なる場合があり、OAuth トークンが最大5個に制限されている可能性があります。追加の endpoint へのアクセスや既存アプリケーションのトークン上限の解除については、アクセス拡張ガイドを参照してください。

​
はじめてのリクエストを送信する

X Ads API へのアクセスをテストするには、GET accounts endpoint にリクエストを送信します。この endpoint は、現在認可されているユーザーがアクセスできる広告アカウントを返します。以降の API リクエストで特定の広告アカウントの data を読み書きする際は、このリクエストで取得した広告アカウントの id を使用します。コマンドラインで Twurl を使用する場合、リクエストは次のようになります。 リクエスト例 
twurl -H ads-api.x.com "/11/accounts"
応答例 
{
  "request": {
    "params": {}
  },
  "data": [
   {
    "name": "Furni",
    "business_name": null,
    "timezone": "America/Los_Angeles",
    "timezone_switch_at": "2016-04-06T07:00:00Z",
    "id": "18ce54ayf0z",
    "created_at": "2016-04-07T14:40:15Z",
    "salt": "b88939e5cabbca720159cb3659d73c06",
    "updated_at": "2017-02-08T08:49:53Z",
    "business_id": null,
    "approval_status": "ACCEPTED",
    "deleted": false
     }
   ]
}

​
次のステップ …

⌘I