ステップバイステップガイド

Ads API へのアクセス方法

1. 開発者アカウントに登録します。
2. developer App](/fundamentals/developer-apps) を作成し、トークンを安全に保管します。
3. ads.x.com/help にアクセスして、各 developer App に対する Ads API アクセスのリクエストを送信します。

注: すでに X Developer Platform 上で開発を行っており、開発者アカウントをお持ちの場合は、ステップ 3 にスキップしてください。

ステップ 1: 開発者アカウントへの登録

X の API プロダクトにリクエストを送信するには、まず開発者アカウントに登録する必要があります。Developer Console 内で App および developer App を作成します。これにより、API へのすべてのリクエストの認証に使用する一連のクレデンシャルが提供されます。

ステップ 2: App のキーとトークンを安全に保管する

developer App 内では、API キー(Consumer Keys とも呼ばれます)のセットが提供されます。また、ご自身の X アカウントの代理としてリクエストを行うために使用できる Access Tokens のセットや、OAuth 2.0 Bearer Token を必要とするエンドポイントの認証に使用できる Bearer Token を生成することもできます。これらのキーとトークンは再生成しない限り有効期限が切れないため、環境変数を作成するか、安全なパスワードマネージャーを使用することを推奨します。

また、App ID は App 詳細の URL に表示されるので、メモしておいてください。次のステップで Ads API へのアクセスをリクエストする際に役立ちます。

注: キーとトークンは Developer Console に一度しか表示されないため、生成後はすぐにパスワード管理システムに保存することが重要です。

キーとトークンを紛失または忘れた場合は、再生成が必要となり、新しいキーとトークンが作成されて古いものは無効になります。つまり、以前のクレデンシャルで設定したすべての連携を更新する必要があります。

認証のベストプラクティスについて詳しく学べます。

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

この時点で X API への基本的なアクセスは可能になりますが、X Ads API 固有の機能にはアクセスできません。次に、Ads API アクセスをリクエストし、承認される必要があります。ads.x.com/help にアクセスして、各 developer App に対する Ads API アクセスのリクエストを送信してください。

アクセスティア

申請プロセスの一環として、必要なアクセスレベルを指定する必要があります。App レベルおよび Ad Account レベルの権限について詳しく学べます。

Conversion Only

Mobile および Web Conversion エンドポイントへの読み取り・書き込みアクセス。

Standard Access

Analytics、Campaign Management、Creatives、Custom Audiences、および Conversion エンドポイントへの読み取り・書き込みアクセス。

注: アプリが Ads API アクセスの承認を受けた後、適切に認証された Ads API リクエストを行うために、ユーザーアクセストークンを再生成する必要があります。

注: 2023 年 7 月以前にアクセスをリクエストした Ads API 開発者は、異なるレベルのアクセスや権限を持っている場合があり、OAuth トークンが 5 つまでに制限されている場合があります。既存のアプリケーションで追加のエンドポイントへのアクセスやトークン制限の引き上げが必要な場合は、アクセスの拡張に関するガイドをご覧ください。

最初のリクエストを送る

Ads API へのアクセスをテストするには、GET accounts エンドポイントにリクエストを送ります。このエンドポイントは、現在認証されたユーザーがアクセス可能な広告アカウントを返します。このリクエストで得られた広告アカウント ID を、後続の 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
     }
   ]
}

次に学ぶ …

• Ads API ドキュメントで、バージョニングや階層などの基本を確認しましょう。
• Ads API 連携に役立つさまざまな Ads API ツールとライブラリ を確認しましょう。
• Ads API アクセスの拡張の手順を理解しましょう。
• 利用可能なサポートリソースに慣れておきましょう。
• X のプロモートプロダクトの API 変更、サービス問題、機能強化に関するリアルタイム情報については、@API をフォローしてください。