認証と HTTP ヘッダー

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

OAuth 2.0 認証情報

Search Ads 360 Reporting API は、アプリケーションの認証情報を使用して API リクエストを識別し、承認します。OAuth 2.0 クライアントを構成できます。すべての Search Ads 360 Reporting API の呼び出しは、OAuth2 による認証を受ける必要があります。OAuth2 を使うことで、検索広告 360 Reporting API クライアント アプリケーションは、ユーザーのログイン情報を保存したり処理したりしなくてもユーザーの検索広告 360 アカウントにアクセスできるようになります。

Google API を初めて使用する場合は、oauth2l または OAuth 2.0 Playground を使用して、アプリのコードを作成する前に、アプリケーションの認証情報と Search Ads 360 Reporting API をテストできます。また、提供されているユーザー認証情報生成スクリプトを実行して、OAuth 更新トークンを生成することもできます。

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

クライアント 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 リクエストから返されたアクセス トークンを、Search Ads 360 Reporting API へのすべての API 呼び出しの Authorization HTTP ヘッダーで使用します。

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN

リクエスト ヘッダー

ログイン用お客様 ID

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

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

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID

レスポンス ヘッダー

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

リクエスト ID

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

request-id: 2a5Cj89VV7CNhya1DZjjrC