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

​
Ads API へのアクセス方法

  1. 開発者アカウント にサインアップします。
  2. 開発者アプリ を作成し、トークンを安全に保管します。
  3. ads.x.com/help にアクセスし、各開発者アプリごとに Ads API アクセスの申請を行います。
注: すでに X Developer Platform 上で開発を行っており、開発者アカウントをお持ちの場合は、手順 3 に進んでください。

​
ステップ1：開発者アカウントにサインアップする

X の API 製品にリクエストを送信するには、まず開発者アカウントにサインアップする必要があります。開発者ポータルで Project と開発者アプリを作成してください。これにより、API へのすべてのリクエストの認証に使用する一連の認証情報が付与されます。

​
ステップ2：アプリのキーとトークンを保存し、安全に保管する

開発者向けアプリでは、API Key（Consumer Key とも呼ばれます）のセットが提供されます。個人の X アカウントの代理でリクエストを行うために使用できる Access Token のセットや、OAuth 2.0 Bearer Token を要するエンドポイントの認証に使用できる Bearer Token を生成することもできます。これらのキーやトークンは再生成しない限り有効期限がないため、環境変数を用意するか、安全なパスワードマネージャーを使用することを推奨します。 また、アプリ詳細の URL に記載されている App ID も控えておいてください。これは次の手順で Ads API へのアクセスを申請する際に役立ちます。
注: キーやトークンは開発者ポータルで一度しか表示されないため、生成後すぐにこれらの認証情報をパスワード管理システムに保存することが重要です。キーやトークンを紛失・失念した場合は再生成が必要になり、新しいキーとトークンが作成され、古いものは無効化されます。つまり、以前の認証情報で構成していた連携は更新が必要になります。認証のベストプラクティスについて詳しく学べます。

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

この時点で、X API へのベーシックアクセスはありますが、X Ads API の特定機能にはアクセスできません。次に、Ads API へのアクセスを申請し、承認を受ける必要があります。各開発者アプリの Ads API アクセスを申請するには、ads.x.com/help にアクセスしてください。

​
アクセス階層

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

​
コンバージョンのみ

読み取りおよび書き込み権限で、モバイルおよびウェブのコンバージョンエンドポイントにアクセスできます。

​
スタンダードアクセス

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

​
最初のリクエストを実行する

Ads API へのアクセスをテストするには、GET accounts エンドポイントにリクエストを送信します。このエンドポイントでは、現在認可されているユーザーがアクセスできる広告アカウントが返されます。このリクエストで取得した広告アカウントのIDは、特定の広告アカウントのdataを読み書きする後続のAPIリクエストで使用します。コマンドラインで 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
     }
   ]
}

​
次のステップ …