Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

Authorization と 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 へのアクセスに使用する scopehttps://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

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

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

リクエスト ヘッダー

開発者トークン

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

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

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

ログインお客様 ID

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

このヘッダーを含めるのは、ログインした後、またはページのプロフィール画像をクリックした後に Google 広告の管理画面でアカウントを選択するのと同じです。お客様 ID を指定する場合は、ハイフン(-)をすべて削除してください(例: 123-456-78901234567890 など)。

GET /v11/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