Authentication

Google アド マネージャー API の呼び出しはすべて、OAuth2 を使用して承認する必要があります。OAuth2 は、ユーザーがサードパーティのアプリケーションに権限を付与して、アプリケーションがユーザーに代わってウェブサービスとやり取りできるようにするオープン スタンダードです。OAuth2 を使うことで、アド マネージャー API クライアント アプリケーションは、ユーザーのユーザー名やパスワードを保存したり処理したりしなくてもユーザーのアド マネージャー アカウントにアクセスできるようになります。

OAuth2 認証情報を作成する

OAuth2 認証情報を生成するには、次の手順を行います。

1. 認証タイプを決定する

下の表で、アド マネージャー API アプリケーションに最も適した認証タイプ を確認します。

OAuth2 認証タイプを選択する
サービス アカウント

自分のアド マネージャー データにのみアクセスする必要がある場合は、これを選択します。

詳細
ウェブ アプリケーション

アプリケーションにアド マネージャー データへのアクセスを許可するユーザーとして認証を行う場合は、これを選択します。

詳細

2. OAuth2 認証情報を作成する

認証タイプが決まったら、下の該当するタブをクリックし、手順に沿って OAuth2 認証情報を生成します。

サービス アカウント
  1. Google API Console の認証情報ページを開きます。
  2. プロジェクトのプルダウンから [新しいプロジェクトを作成] を選択し、プロジェクトの名前 を入力します。必要に応じて、指定されたプロジェクト ID を編集します。[作成] をクリックします。
  3. [認証情報] ページで [認証情報を作成] を選択し、 [サービス アカウント キー] を選択します。
  4. [新しいサービス アカウント] を選択し、[**JSON**] を選択します。
  5. [作成] をクリックして、秘密鍵を含むファイルをダウンロードします。
ウェブ アプリケーション
  1. Google API Console の認証情報ページを開きます。
  2. プロジェクトのプルダウンから [新しいプロジェクトを作成] を選択し、プロジェクトの名前を入力します（必要に応じて、指定されたプロジェクト ID を編集します）。[作成] をクリックします。
  3. [認証情報] ページで [認証情報を作成] を選択し、 [OAuth クライアント ID] を選択します。
  4. 同意画面のページでプロダクト名の設定を促された場合は、[同意画面を設定]をクリックして必要な情報を入力し、[保存]をクリックして認証情報ページに戻ります。
  5. [アプリケーションのタイプ] は [ウェブ アプリケーション] を選択します。手順に沿って、JavaScript 生成元とリダイレクト URI のどちらか、または両方を入力します。
  6. [作成] をクリックします。
  7. 表示されたページで、クライアント ID とクライアント シークレット をクリップボードにコピーします。この 2 つはクライアント ライブラリの設定時に必要になります。
クライアント ID とクライアント シークレットのスクリーンショット

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

サードパーティのデベロッパーの場合は、クライアントにこの手順を行ってもらう必要があるかもしれません。

サービス アカウント
  1. アド マネージャー ネットワークに移動します。
  2. [管理者] タブをクリックします。
  3. [API アクセス] が有効になっていることを確認します。
  4. [サービス アカウント ユーザーを追加] ボタンをクリックします。
  5. サービス アカウントのメールアドレスを使用してフォームに入力します。サービス アカウント ユーザーは、そのサービス アカウント ユーザーが UI でエンティティにアクセスする場合と同じように、エンティティにアクセスする権限が付与されている必要があります。
  6. [保存] ボタンをクリックします。サービス アカウントの追加を確認するメッセージが表示されます。
  7. 既存のサービス アカウント ユーザーを表示するには、[ユーザー] タブに移動し、 [サービス アカウント] フィルタをクリックします。
ウェブ アプリケーション
  1. アド マネージャー ネットワークに移動します。
  2. [管理者] タブをクリックします。
  3. [API アクセス] が有効になっていることを確認します。

4. クライアント ライブラリを設定して使用する

クライアント ライブラリで認証情報を使用するには、以下の適切なガイドに沿って操作してください。

Google のクライアント ライブラリを使用しない場合は、OAuth2 サービス アカウントまたは ウェブ アプリ フローを自分で実装する必要があります。

舞台裏

Google のクライアント ライブラリでは、以下で説明する処理が自動的に行われます。ですから、クライアント ライブラリを使用しない場合や具体的な仕組みに関心がある場合にのみ読み進めてください。 このセクションは、すでに OAuth2 の仕様に精通しており、 Google API における OAuth2. の使い方を理解されている上級者向けの説明です。

HTTP リクエスト ヘッダー

アド マネージャー API へのすべてのリクエストの HTTP ヘッダーには、次の形式でアクセス トークンが含まれている必要があります。

Authorization: Bearer ACCESS_TOKEN

次に例を示します。

POST … HTTP/1.1
Host: …
Authorization: Bearer 1/fFAGRNJru1FTz70BzhT3Zg
Content-Type: text/xml;charset=UTF-8
Content-Length: …

<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope">
…
</soap:Envelope>

スコープ

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

アド マネージャーには、以下に示す 1 つのスコープのみがあります。承認は、プロダクト内のユーザーレベルで行う必要があります。

スコープ 権限
https://www.googleapis.com/auth/admanager アド マネージャーでのキャンペーンの表示と管理。