Google Ads API に Google API Console プロジェクトを設定する

Google の OAuth2 サーバーにアクセスするための認証情報は、Google 広告ユーザーを認証したり承認したりするために必要です。これらの認証情報により、Google がアプリの識別を行い、OAuth トークンを生成して Google 広告のユーザーを管理できるようになります。Google OAuth2 認証情報へのアクセスは、Google API Console で管理されています。

Cloud プロジェクトのベスト プラクティスに関する動画

Google OAuth の確認

Google Ads API スコープの認証情報の取得に使用する Google Cloud アプリは、ユーザーの未確認の UI 画面を避けるために、Google OAuth 検証を行う必要があります。このコンテキストのアプリは、Google Cloud で一意の OAuth 2.0 クライアント ID として定義されます。

この確認は独立したものであり、開発者トークンの承認プロセスの一環として実施される審査に加えて行われ、Google Ads API のスコープは機密性の高いスコープであるため必須です。

Google による適格性確認に費用は発生しません。通常、この確認手続きは 3 ~ 5 営業日以内に完了します。このポリシーはすべてのアプリに適用されます。

業務の中断を避けるため、すべてのアプリでできるだけ早く Google OAuth 検証プロセスを実施することをおすすめします。

プロジェクトを作成する

Google API Console に移動します。[プロジェクトを作成] をクリックし、名前を入力して [作成] をクリックします。

プロジェクトで Google Ads API を有効にする

プロジェクトで Google Ads API を有効にする手順は次のとおりです。

  1. Google API コンソールで API ライブラリを開きます。プロンプトが表示されたら、プロジェクトのいずれかを選択するか、新しいプロジェクトを作成します。API ライブラリには、利用できるすべての API がプロダクト ファミリーと人気度によって分類され、表示されます。

  2. リストに表示されない場合は、検索を使用して Google Ads API を見つけます。

  3. API を選択し、[有効にする] ボタンをクリックします。

ユーザータイプと公開ステータスを選択する

API を有効にしたら、プロジェクトの [ユーザータイプ] と [公開ステータス] を指定する必要があります。次の表に、これらの設定の各組み合わせの主な属性と制限事項を示します。詳細については、Google Cloud Platform のドキュメントをご覧ください。

ユーザーの種類 公開ステータス 制限事項
内部 テスト
  • Google Cloud 組織に関連付けられたプロジェクトでのみ使用できます。
  • OAuth 同意画面に表示されるテストユーザーは最大 100 人に制限されています。
  • テストユーザーは、プロジェクトに関連付けられている Google Cloud 組織の内部ユーザーである必要があります。
  • 承認は、同意後 7 日間有効です。
外部 テスト
  • すべてのプロジェクトで使用できます。
  • OAuth 同意画面に表示されるテストユーザーは最大 100 人に制限されています。
  • テストユーザーは、Google アカウントを持つ任意のユーザーです。
  • 承認は、同意後 7 日間有効です。
内部 本番環境
  • Google Cloud 組織に関連付けられたプロジェクトでのみ使用できます。
  • プロジェクトに関連付けられた Google Cloud 組織内のユーザーの認証を許可します。
外部 本番環境
  • すべてのプロジェクトで使用できます。
  • Google アカウントを持つ任意のユーザーの認証を許可します。

Google OAuth 検証が完了していないと、プロジェクトのユーザータイプ公開ステータスに関係なく、次のようになります。

  • 承認プロセス中は、未検証の UI 画面がユーザーに表示されます。

  • 承認できるのは 100 ユーザーのみです。

  1. [同意画面] ページを開き、ページの上部にあるプルダウン メニューからプロジェクトを選択します。

  2. [ユーザーの種類] を選択し、[作成] をクリックします。

  3. 同意画面フォームに入力します。これは、必要に応じて後で編集できます。完了したら、[保存して次へ] をクリックします。

  4. 次のページで、[スコープを追加または削除] をクリックします。

    • 下にスクロールして、[手動でスコープを追加] のフィールドに次のように入力します。

      https://www.googleapis.com/auth/adwords
      
    • [表に追加] をクリックします。

    • プロジェクトでリクエストする他のスコープを追加し、[更新] をクリックします。

    • [保存して次へ] をクリックします。

  5. プロジェクトをすぐに公開しない場合は、テストに使用する各ユーザー アカウントのメールアドレスを追加して、[保存して次へ] をクリックします。

  6. 概要ページを確認し、[ダッシュボードに戻る] をクリックします。

アプリケーションと承認プロセスをテストしたら、ダッシュボードに戻り、[アプリを公開] をクリックして、公開ステータスを [テスト] から [本番環境] に変更できます。

アプリの種類を選択する

Google Ads API には、PC とウェブの 2 種類のアプリタイプ オプションがあります。次の表を参考にして、ビルドするアプリに最も適したタイプを判断してください。

アプリケーションのタイプ 適しているケース
デスクトップ アプリ
  • すべての Google 広告アカウントを 1 つの最上位の MCC アカウントで管理している。
  • API をはじめて利用する場合や、簡単な設定ですぐに利用を開始したい場合
  • アプリは 1 台のマシンからのみ Google ユーザーを認証します。
ウェブアプリ
  • アプリケーションに Google 広告アカウントのデータへのアクセスを許可するユーザーとして認証を行う場合
  • 複数の認証情報を簡単に生成して、サードパーティなどのアカウントを管理したい場合
  • アプリにコールバック URL が必要です。コールバック URL は、デスクトップ アプリのフローではサポートされていません。

詳細については、Google Identity Platform の OAuth に関するドキュメント(デスクトップ アプリまたはウェブアプリ)をご覧ください。

クライアント ID とクライアント シークレットを作成する

アプリケーションのタイプが決まったら、次の手順に沿って OAuth2 クライアント ID とクライアント シークレットを生成します。

  1. [認証情報] ページを開きます。 以前に作成したプロジェクトを選択するか、新しいプロジェクトを作成します。

  2. [認証情報] 画面で [認証情報を作成] をクリックし、[OAuth クライアント ID] を選択します。

    1. このプロジェクトで OAuth 同意画面をまだ構成していない場合は、ここで構成するように指示されます。[同意画面を構成] をクリックします。

      1. ユーザータイプを選択し、[作成] をクリックします。

      2. 最初のフォームに入力します。これは、必要に応じて後で編集できます。完了したら [保存] をクリックします。

    2. [認証情報] > [認証情報を作成] > [OAuth クライアント ID] に戻って続行します。

  3. ユースケースに応じて、アプリの種類として [デスクトップ アプリ] または [ウェブ アプリケーション] を選択します。

  4. 名前を付けて [作成] をクリックします。

  5. クライアント タイプがウェブ アプリケーションの場合は、承認済みのリダイレクト URI を 1 つ以上追加します。

    クライアント ライブラリのサンプルのデフォルト構成と互換性のあるローカルテストの場合は、http://127.0.0.1 を使用します。

    デスクトップ アプリ クライアントの場合、引き続きループバック IP リダイレクトを使用しますが、URI は Cloud コンソールで明示的に構成されていません。

  6. クライアント ライブラリを構成するときに必要になるため、確認ページでクライアント IDクライアント シークレットをクリップボードにコピーします。後で認証情報ページに戻って詳細を取得することもできます。