Authentication

このドキュメントでは、Ad Manager API の認証方法について説明します。Google 使用するインターフェースと、使用する環境によって、 が、すべての API リクエストには、API トークンを Ad Manager API のスコープ

アド マネージャー クライアント ライブラリは、アプリケーションのデフォルト認証情報を使用して、アド マネージャー API スコープのアクセス トークンを生成します。このガイドでは、アプリケーションのデフォルト認証情報を構成する方法について説明します。

クライアント ライブラリを使用していない場合でも、認証情報を作成して、その認証情報を使用してリクエストを承認する必要があります。

認証と承認の詳細については、OAuth 2.0 の使用ガイドをご覧ください。

認証タイプを決定する

認証タイプ 説明
サービス アカウント 特定のユーザーではなく、専用アカウントとして認証する場合に選択します。
詳細
ウェブ アプリケーション 任意のユーザーとして認証する場合は、これを選択します。 アプリケーションにアクセスする権限を付与するユーザー アドマネージャーのデータを処理できます
詳細
ローカルでの開発 ローカル開発環境の独自の Google アカウントまたはサービス アカウントとして認証する場合は、このオプションを選択します。

Ad Manager API を有効にする

  1. Google API Console の Cloud プロジェクトで Ad Manager API を有効にします。

  2. プロンプトが表示されたら、プロジェクトのいずれかを選択するか、新しいプロジェクトを作成します。

認証情報を作成

認証タイプのタブをクリックし、 認証情報を作成します。

サービス アカウント

Google Cloud

Google Cloud で実行されているワークロードを認証するには、Google Cloud の コードが配置されているコンピューティング リソースに できます。

たとえば、サービス アカウントを Compute Engine 仮想マシン(VM)インスタンス、Cloud Run サービス、Dataflow ジョブに関連付けることができます。このアプローチは、Google Cloud コンピューティング リソースで実行されているコードの推奨認証方法です。

サービス アカウントを接続できるリソースについては、 サービス アカウントをリソースに関連付ける方法については、 サービス アカウントの接続に関するドキュメントをご覧ください。

オンプレミスまたは別のクラウド プロバイダ

Google Cloud の外部から認証を設定する際の推奨方法は、 Workload Identity 連携を使用する。新しい 認証情報の構成ファイルを作成し、GOOGLE_APPLICATION_CREDENTIALS を そのリソースを指定します。この方法は、他の VM よりも サービス アカウント キーを作成します。

Workload Identity 連携を構成できない場合は、次のことを行う必要があります。 サービス アカウントを作成し、そのサービス アカウントのキーを作成します。

  1. Google API Console の認証情報ページを開きます。

  2. [認証情報] ページで [認証情報を作成] を選択し、 [Service Account] を選択します。

  3. 作成するサービス アカウントのメールアドレスをクリックします。 指定します。

  4. [キー] タブをクリックします。

  5. [鍵を追加] プルダウン メニューをクリックして、[新しい鍵を作成] を選択します。

  6. 鍵のタイプとして [JSON] を選択し、[作成] をクリックします。

  7. 環境変数 GOOGLE_APPLICATION_CREDENTIALS を JSON ファイルのパスに設定します。

Linux または macOS

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

ウェブ アプリケーション

  1. Google API Console の認証情報ページを開きます。

  2. プロンプトが表示されたら、Ad Manager API を有効にしたプロジェクトを選択します。

  3. [認証情報] ページで [認証情報を作成] を選択し、 [OAuth クライアント ID] を選択します。

  4. アプリケーションの種類として [ウェブ アプリケーション] を選択します。

  5. フォームに記入し、[作成] をクリックします。言語と方法を使用するアプリケーション フレームワーク(PHP、Java、Python、Ruby、.NET など)では、 リダイレクト URI。リダイレクト URI は、OAuth 2.0 サーバーの レスポンスを送信できます。これらのエンドポイントは、Google の検証ルールに準拠している必要があります。

  6. 認証情報を作成したら、client_secret.json ファイルをダウンロードします。そのアプリケーションだけがアクセスできる場所にファイルを安全に保存します。

手順に沿って、OAuth 2.0 アクセス トークンを取得します。

ローカルでの開発

ローカル環境でアプリケーションのデフォルト認証情報(ADC)を設定します。

Google Cloud CLI をインストールし、次のコマンドを実行して初期化します。 command:

gcloud init

Google アカウントのローカル認証情報を作成し、プロジェクト ID を Ad Manager API が有効になっているプロジェクトに設定します。

gcloud auth application-default login --scopes="https://www.googleapis.com/auth/admanager"
gcloud auth application-default set-quota-project PROJECT_ID

または、環境を設定するサービス アカウントとして認証します。 変数 GOOGLE_APPLICATION_CREDENTIALS を鍵ファイルのパスに置き換えます。

Linux または macOS

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

アド マネージャー ネットワークを設定する

サービス アカウント

  1. アド マネージャー ネットワークに移動します。
  2. [管理者] タブをクリックします。
  3. API アクセスが有効になっていることを確認します。
  4. [サービス アカウント ユーザーを追加] ボタンをクリックします。
  5. サービス アカウントのメールアドレスを使用してフォームに入力します。「 サービス アカウント ユーザーを適切なロールとチームに追加する必要があります。 API 統合の参考になります
  6. [Save] ボタンをクリックします。サービス アカウントが追加されたことを確認するメッセージが表示されます。
  7. [ユーザー] タブに移動し、[サービス アカウント] フィルタをクリックして、既存のサービス アカウント ユーザーを表示します。

ウェブ アプリケーション

  1. アド マネージャー ネットワークに移動します。
  2. [管理者] タブをクリックします。
  3. [API アクセス] が有効になっていることを確認します。

ローカルでの開発

  1. アド マネージャー ネットワークに移動します。
  2. [管理者] タブをクリックします。
  3. [API アクセス] が有効になっていることを確認します。

クライアント ライブラリを使用しない場合

クライアント ライブラリを使用しない場合でも、 使用します。

アクセス トークンの取得手順については、Google API で OAuth2 を使用するをご覧ください。

アクセス トークン

API へのリクエストにアクセス トークンを含めるには、 access_token クエリ パラメータまたは Authorization HTTP ヘッダーの Bearer 値。 クエリ文字列は頻繁に作成されることが多いため、可能な限り HTTP ヘッダーを使用することをおすすめします。 サーバーログに記録されます。

例:

GET /v1/networks/1234
Host: admanager.googleapis.com
Authorization: Bearer ya29.a0Ad52N3_shYLX
GET https://admanager.googleapis.com/v1/networks/1234?access_token=1/fFAGRNJru1FTz70BzhT3Zg

範囲

各アクセス トークンは 1 つ以上のスコープに関連付けられています。スコープは、 アクセス トークンで許可されるリソースとオペレーションのセットです。アド マネージャー API のスコープは 1 つだけです。承認はユーザー単位で行う必要があります。 継承されます。

範囲 権限
https://www.googleapis.com/auth/admanager Google アド マネージャーでキャンペーンを表示して管理できます。