認証と HTTP ヘッダー

動画: 認証

Google Ads API を呼び出すには、OAuth 2.0 アプリケーション認証情報とデベロッパー トークンの両方が必要です。Google 広告クライアント センター（MCC）アカウントで API 呼び出しを行う場合は、各リクエストで login-customer-id ヘッダーも指定する必要があります。このページでは、これらの値を設定する方法と、REST インターフェースの使用時に送受信される API 固有の HTTP ヘッダーについて説明します。

OAuth 2.0 認証情報

Google Ads API は、アプリケーションの認証情報を使用して API リクエストを識別し、承認します。OAuth 2.0 クライアントとサービス アカウントの両方を構成できます。クライアントサイド認可の設定の詳細については、Google Ads API の OAuth2 をご覧ください。

Google API を初めて使用する場合は、oauth2l または OAuth 2.0 Playground を使用して、アプリのコードを作成する前に、アプリケーションの認証情報と Google Ads API をテストできます。

パソコンまたはウェブアプリのフローを使用する

手順に沿って Google Ads API 用に Google API Console プロジェクトを設定します。クライアント ID とクライアント シークレットを記録してから、このページに戻ります。

OAuth クライアントを作成したら、デスクトップ アプリのフローの手順またはウェブアプリのフローの手順に沿って、更新トークンとアクセス トークンを生成します。

サービス アカウントを使用する

サービス アカウント ガイドの一般的な手順に沿って、Google Ads API のサービス アカウント アクセスを設定します。

Google 広告アカウントにアクセスするサービス アカウントを設定したら、サーバー間アプリケーションに OAuth 2.0 を使用するガイドに沿って、[HTTP/REST] タブを選択します。Google Ads API へのアクセスに使用する scope は https://www.googleapis.com/auth/adwords です。

新しいアクセス トークンの生成

クライアント ID、クライアント シークレット、更新トークンを取得したら、curl コマンドライン ツールを使用して、API 呼び出しで使用する新しいアクセス トークンを生成できます。

curl \
  --data "grant_type=refresh_token" \
  --data "client_id=CLIENT_ID" \
  --data "client_secret=CLIENT_SECRET" \
  --data "refresh_token=REFRESH_TOKEN" \
  https://www.googleapis.com/oauth2/v3/token

次に、curl リクエストから返されたアクセス トークンを、Google 広告 API へのすべての API 呼び出しの Authorization HTTP ヘッダーで使用します。

GET /v19/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

リクエスト ヘッダー

開発者トークン

また、Google Ads API を呼び出すには、開発者トークンも必要です。クライアント センター（MCC）アカウントのトークンは、Google 広告の管理画面から直接申請できます。開発者トークンの設定の詳細については、開発者トークンを取得するをご覧ください。

Google Ads API へのすべての API 呼び出しの developer-token HTTP ヘッダーに、開発者トークンの値を含める必要があります。

GET /v19/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

ログイン用お客様 ID

マネージャーがクライアント アカウントに対して行う Google 広告 API 呼び出し（マネージャーとしてログインしてクライアント アカウントに対して API 呼び出しを行う場合）では、login-customer-id HTTP ヘッダーも指定する必要があります。この値は、API 呼び出しを行うマネージャーの Google 広告のお客様 ID を表します。

このヘッダーを含めると、ログインした後に Google 広告 UI でアカウントを選択するか、ページの右上にあるプロフィール画像をクリックするのと同じ効果があります。お客様 ID を指定する際は、ハイフン（-）を削除してください（例: 1234567890、123-456-7890 ではない）。

GET /v19/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID

リンクされているお客様 ID

このヘッダーは、リンクされた Google 広告アカウントにコンバージョンをアップロードする際に、第三者アプリ分析プロバイダが使用するのみです。詳細については、API 呼び出し構造ガイドをご覧ください。

...
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
linked-customer-id: LINKED_CUSTOMER_ID

レスポンス ヘッダー

API からの HTTP レスポンスには、次のヘッダーが返されます。

リクエスト ID

request-id は、API リクエストを一意に識別する文字列です。特定の API 呼び出しに関する問題のデバッグやトラブルシューティングを行う場合は、Google デベロッパー サポートに問い合わせる際に便利な重要な識別子である request-id を取得します。

request-id: 2a5Cj89VV7CNhya1DZjjrC
前へ
はじめに
次へ
概要