Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.x.com/llms.txt

Use this file to discover all available pages before exploring further.

Ads API へのアクセス方法

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

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

X のいずれかの API プロダクトにリクエストを送るには、まず開発者アカウントにサインアップする必要があります。Developer Console 内で、App と開発者 App を作成します。これにより、API へのすべてのリクエストの認証に使用する一連の認証情報が提供されます。

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

開発者 App 内で、一連の API キー(コンシューマーキーとも呼ばれます)が提供されます。また、ご自身の X アカウントの代理でリクエストを行うために使用できる Access Token のセットと、OAuth 2.0 Bearer Token を必要とするエンドポイントを認証するために使用できる Bearer Token を生成する機会もあります。これらのキーとトークンは再生成しない限り期限切れにならないため、環境変数を作成するか、安全なパスワードマネージャーを使用することをお勧めします。 また、App の詳細の URL に表示される App ID もメモしておいてください。これにより、次のステップで Ads API へのアクセスをリクエストする際に役立ちます。
注: キーとトークンは Developer Console に一度しか表示されないため、生成したらすぐにパスワード管理システムに保管することが重要です。キーとトークンを紛失または忘れた場合は、再生成する必要があります。再生成すると新しいキーとトークンが作成され、古いものは無効になります。これは、以前の認証情報で設定したインテグレーションを更新する必要があることを意味します。認証のベストプラクティスについて詳しく学べます。

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

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

アクセスティア

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

Conversion Only

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

Standard Access

Analytics、Campaign Management、Creatives、Custom Audiences、および Conversion エンドポイントへの読み取りおよび書き込みアクセス。
注: App が 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
     }
   ]
}

次のステップ …