認証と 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

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

GET /v16/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 /v16/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

ログインのお客様 ID

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

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

GET /v16/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 リクエストを一意に識別する文字列です。request-id は、特定の API 呼び出しの問題をデバッグまたはトラブルシューティングする場合に、Google デベロッパー サポートに問い合わせる際に便利な識別子です。

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