Google Ads API における OAuth2 の具体的な仕組み

以下で説明するように、クライアント ライブラリによって自動的に処理されるため、 Chronicle の裏で何が行われているかに クライアント ライブラリを使用していない場合です。

このセクションは、すでに使い慣れている上級ユーザーを対象としています。 OAuth 2.0 仕様Google API で OAuth2 を使用する方法を確認する。

API での認証の詳細については、

動画ライブラリ: 認証と認可

範囲

1 つのアクセス トークンで複数の API にさまざまなレベルのアクセス権を付与できます。 scope という変数パラメータにより、リソースとオペレーションのセットを制御します。 アクセストークンで許可されるようにします。アクセス トークンのリクエストの間、アプリは scope パラメータで 1 つ以上の値を送信する。

Google Ads API のスコープは次のとおりです。

https://www.googleapis.com/auth/adwords

オフライン アクセス

Google Ads API クライアント アプリからオフライン アクセスをリクエストするのは、一般的です。たとえば アプリでユーザーが物理的にオンラインでないときにバッチジョブを実行する ウェブサイトの閲覧

種類のウェブアプリでオフライン アクセスをリクエストするには、 access_type パラメータを offline に設定します。詳しくは、 Google の OAuth2 ガイド

デスクトップ アプリの場合、オフライン アクセスはデフォルトで有効になっています。 明示的にリクエストする必要はありません。

リクエスト ヘッダー

gRPC ヘッダー

gRPC API を使用する場合は、各リクエストにアクセス トークンを含めます。バインドできる そのチャンネルのすべてのリクエストで使用するために、CredentialChannel に変更します。Google Chat では 呼び出しごとにカスタマイズされた認証情報も送信します。gRPC 承認ガイドに、 承認の処理に関する詳細をご覧ください。

REST ヘッダー

REST API を使用する場合は、HTTP ヘッダーでアクセス トークンを渡す Authorization。HTTP リクエストのサンプルを以下に示します。

GET /v17/customers/123456789 HTTP/2
Host: googleads.googleapis.com
User-Agent: INSERT_USER_AGENT
Accept: */*
Authorization: Bearer INSERT_ACCESS_TOKEN
developer-token: INSERT_DEVELOPER_TOKEN

アクセス トークンとリフレッシュ トークン

ほとんどの場合、更新トークンは後で使用するために安全に保存する必要があります。 アクセス トークンと更新トークンをリクエストする方法については、 次のガイドをご覧ください。

更新トークンの有効期限

更新トークンの有効期限について詳しくは、Google Identity Platform の OAuth ドキュメントをご覧ください。

アクセス トークンの期限切れ

アクセス トークンには有効期限( expires_in 値) トークンがもはや無効になります。更新トークンを使用して アクセス トークンの有効期限が切れたことを意味します。クライアント ライブラリでは、期限切れのアクセス トークンはデフォルトで自動的に更新されます。