はじめに

広告APIへのアクセス方法

  1. 開発者アカウントに登録する
  2. 開発者アプリを作成し、トークンを確保する
  3. 営業担当者を通して広告APIへのアクセス申請を行う

注:  Twitter開発者プラットフォームを構築済みで、開発者アカウントを保有している場合は、手順3に進んでください。

手順1: 開発者アカウントに登録する

TwitterのAPI商品をリクエストするには、まず開発者アカウントに登録する必要があります。開発者ポータルで、プロジェクトと開発者アプリを作成します。作成すると、APIへのすべてのリクエストの認証に使用する資格情報のセットが提供されます。

開発者アカウントに登録する


手順2: アプリのキーとトークンを保存し、安全に保管する

開発者アプリ内にAPIキーセット（別名「コンシューマーキー」）が提供されます。Twitter個人アカウントの代理でリクエストを行うために使用できるアクセストークンセットと、OAuth 2.0ベアラートークンが必要なエンドポイントの認証に使用できるベアラートークンを生成することもできます。これらのキーとトークンは、再生成されないかぎりは期限が切れないため、環境変数を作成するか、安全なパスワードマネージャーを使用することをお勧めします。

また、アプリ詳細のURLで確認できるアプリIDをメモしておいてください。次のステップで広告APIへのアクセスをリクエストするのが簡単になります。

注: キーとトークンが開発者ポータルに表示されるのは1度のみです。そのため、認証情報は生成したらすぐにパスワード管理システムに保存するようにしてください。

キーとトークンをなくした場合や忘れた場合には再生成する必要があります。再生成すると新しいキーとトークンが作成され、古いものは無効になります。そのため、古い認証情報で構成した統合は更新する必要があります。2021年1月まで、アプリのキーとトークンは開発者ポータルから取得できます。

詳細は、当社の認証のベストプラクティスを参照してください。 

手順3: 広告APIへのアクセスを申請する

この段階では、Twitter APIへの基本的なアクセス権はありますが、Twitter広告APIの特定機能へのアクセス権はありません。アクセス権を得るには、営業担当を通して申請をし、承認を受ける必要があります。

アクセスレベル

申請を行う際に、必要なアクセスレベルについても伝えてください。アクセスレベルについては、アプリレベルとアカウントレベル権限をご確認ください。

コンバージョンのみ

モバイルとウェブコンバージョンのエンドポイントへのRead onlyのアクセスが可能です。

スタンダードアクセス

アナリティクス、キャンペーンマネージメント、クリエイティブ、カスタムオーディエンス、コンバージョンエンドポイントへのRead and writeのアクセスが可能です。

注: 2023年7月以前に広告APIへのアクセスをリクエストした方は、別のアクセスや権限が付与されており、OAuthトークンの上限が5つまでとなっている可能性があります。追加のエンドポイントへのアクセスや、トークンの上限を外したい場合は、アクセス権の引き上げページをご確認ください。

最初のリクエストを行う

GET accountsエンドポイントにリクエストを実行して、広告APIへのアクセスをテストします。このエンドポイントは、現在ユーザーアクセスが許可されている広告アカウントを返します。後続のAPIリクエストでは、このリクエストの広告アカウントIDを使用して、特定の広告アカウントへのデータの読み書きを実行します。コマンドラインでTwurlを使用すると、リクエストは次のようになります。

リクエストの例

      twurl -H ads-api.x.com "/10/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
  }
}

 

次のステップ . . .