認証と HTTP ヘッダー

Search Ads 360 Reporting API を呼び出すには、OAuth 2.0 アプリケーションの認証情報が必要です。検索広告 360 のクライアント センター(MCC)アカウントとして 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 を使用すると、Search Ads 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

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

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 呼び出しを行うマネージャーの検索広告 360 お客様 ID を表します。

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

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

request-id: 2a5Cj89VV7CNhya1DZjjrC