認証と承認

他の Google API と同様に、Google Ads API は認証と認可に OAuth 2.0 プロトコルを使用します。OAuth 2.0 を使用すると、Google 広告 API クライアント アプリは、ユーザーのログイン情報を処理または保存することなく、ユーザーの Google 広告アカウントにアクセスできます。

Google 広告のアクセスモデルについて

Google Ads API を効果的に使用するには、Google Ads のアクセスモデルの仕組みを理解する必要があります。Google 広告アクセスモデル ガイドを参照してください。

OAuth ワークフロー

Google Ads API を使用する際に使用される一般的なワークフローは 3 つあります。

サービス アカウントのフロー

ワークフローでユーザーの操作が必要ない場合は、このワークフローをおすすめします。このワークフローでは、ユーザーが サービス アカウントを Google 広告アカウントに追加する構成手順が必要です。アプリは、サービス アカウントの認証情報を使用して、ユーザーの Google 広告アカウントを管理できます。これを構成するには、Google Cloud コンソールで JSON キーファイルを作成してダウンロードし、google_ads_config.rb をホーム ディレクトリにコピーして、サービス アカウント キーファイルの場所（および Google Workspace ドメイン全体の委任を使用するときに権限を借用するユーザーのメールアドレス（省略可））を指定するように変更します。

# You can also authenticate using a service account. If "keyfile" is
# specified below, then service account authentication will be assumed and
# the above authentication fields ignored. Read more about service account
# authentication here:
# https://developers.google.com/google-ads/api/docs/oauth/service-accounts
c.keyfile = 'path/to/keyfile.json'
# Optional unless using Google Workspace domain-wide delegation:
c.impersonate = 'INSERT_EMAIL_ADDRESS_TO_IMPERSONATE_HERE'

この情報をファイルに保存したくない場合は、環境変数を使用できます。GOOGLE_ADS_JSON_KEY_FILE_PATH（および必要に応じて GOOGLE_ADS_IMPERSONATED_EMAIL）を設定します。

export GOOGLE_ADS_JSON_KEY_FILE_PATH="/path/to/your/service-account-key.json"
# Optional unless using Google Workspace domain-wide delegation:
export GOOGLE_ADS_IMPERSONATED_EMAIL="your_email@email.com"

サービス アカウント キーファイル パス（および必要に応じて権限借用メールアドレス）を、実行時にプログラムで渡すこともできます。

require 'google/ads/google_ads'

client = Google::Ads::GoogleAds::GoogleAdsClient.new do |config|
  config.keyfile = '/path/to/your/service-account-key.json'
  # Optional unless using Google Workspace domain-wide delegation:
  config.impersonate = 'INSERT_EMAIL_ADDRESS_TO_IMPERSONATE_HERE'
end

または、googleauth gem を使用してサービス アカウントの認証情報を作成し、credentials.updater_proc を config.authentication に渡すこともできます。

require 'googleauth'
require 'google/ads/google_ads'

# Path to your service account key file.
key_file = '/path/to/your/service-account-key.json'

# Define the scopes needed for the Google Ads API.
scopes = ['https://www.googleapis.com/auth/adwords']

# Create service account credentials.
credentials = File.open(key_file) do |io|
  Google::Auth::ServiceAccountCredentials.make_creds(
    json_key_io: io,
    scope: scopes
  )
end

# Initialize the Google Ads API client with these credentials.
client = Google::Ads::GoogleAds::GoogleAdsClient.new do |config|
  # Inject the service account credential updater proc.
  config.authentication = credentials.updater_proc
end

詳細については、サービス アカウントのワークフロー ガイドをご覧ください。

シングル ユーザー認証フロー

このワークフローは、サービス アカウントを使用できない場合に使用できます。このワークフローには、次の 2 つの構成手順が必要です。

  1. Google Ads API を使用して管理するすべてのアカウントへのアクセス権を 1 人のユーザーに付与します。一般的な方法としては、ユーザーに Google Ads API の MCC アカウントへのアクセス権を付与し、その MCC アカウントにすべての Google 広告アカウントをリンクします。
  2. ユーザーが Google Cloud コマンドライン ツールや GenerateUserCredentials コード例などのコマンドライン ツールを実行して、ユーザーのすべての Google 広告アカウントをユーザーに代わって管理する権限をアプリに付与します。

OAuth 2.0 認証情報は、google_ads_config.rb ファイルをホーム ディレクトリにコピーし、クライアント ID、クライアント シークレット、更新トークンを含めるように変更することで、Ruby 用に構成できます。

# Authentication tells the API that you are allowed to make changes to the
# specific account you're trying to access.
# The default method of authentication is to use a refresh token, client id,
# and client secret to generate an access token.
c.client_id = 'INSERT_CLIENT_ID_HERE'
c.client_secret = 'INSERT_CLIENT_SECRET_HERE'
c.refresh_token = 'INSERT_REFRESH_TOKEN_HERE'

引数なしでインスタンス化すると、クライアントはホーム ディレクトリから構成ファイルを自動的に読み取ります。

client = Google::Ads::GoogleAds::GoogleAdsClient.new

別の場所にファイルを保存する場合は、このファイルの保存場所のパスを渡してクライアントをインスタンス化します。

client = Google::Ads::GoogleAds::GoogleAdsClient.new(
  'path/to/google_ads_config.rb'
)

この情報をファイルに保存せずに環境変数を使用する場合は、次のコマンドで各変数を設定します。

export GOOGLE_ADS_CLIENT_ID="INSERT_CLIENT_ID_HERE"
export GOOGLE_ADS_CLIENT_SECRET="INSERT_CLIENT_SECRET_HERE"
export GOOGLE_ADS_REFRESH_TOKEN="INSERT_REFRESH_TOKEN_HERE"

ランタイムにプログラムで情報を渡すこともできます。

client = Google::Ads::GoogleAds::GoogleAdsClient.new do |config|
  config.client_id = 'INSERT_CLIENT_ID_HERE'
  config.client_secret = 'INSERT_CLIENT_SECRET_HERE'
  config.refresh_token = 'INSERT_REFRESH_TOKEN_HERE'
end

詳しくは、シングル ユーザー認証のワークフロー ガイドを参照してください。

マルチユーザー認証フロー

アプリでユーザーがログインし、アプリがユーザーの代わりに Google 広告アカウントを管理することを承認できるようにする場合は、このワークフローをおすすめします。アプリは OAuth 2.0 ユーザー認証情報を構築して管理します。このワークフローは、シングル ユーザー フローと同様に構成できます。login_customer_id も指定します。

構成ファイルを使用することをおすすめします。google_ads_config.rb ファイルをホーム ディレクトリにコピーし、クライアント ID、クライアント シークレット、更新トークン、顧客 ID を含めるように変更します。

# Authentication tells the API that you are allowed to make changes to the
# specific account you're trying to access.
# The default method of authentication is to use a refresh token, client id,
# and client secret to generate an access token.
c.client_id = 'INSERT_CLIENT_ID_HERE'
c.client_secret = 'INSERT_CLIENT_SECRET_HERE'
c.refresh_token = 'INSERT_REFRESH_TOKEN_HERE'

# Required for manager accounts only: Specify the login customer ID used to
# authenticate API calls. This will be the customer ID of the authenticated
# manager account. If you need to use different values for this field, then
# make sure to fetch a new copy of the service after each time you change the
# value.
c.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE'

引数なしでインスタンス化すると、クライアントはホーム ディレクトリから構成ファイルを自動的に読み取ります。

client = Google::Ads::GoogleAds::GoogleAdsClient.new

別の場所にファイルを保存する場合は、このファイルの保存場所のパスを渡してクライアントをインスタンス化します。

client = Google::Ads::GoogleAds::GoogleAdsClient.new(
  'path/to/google_ads_config.rb'
)

この情報をファイルに保存せずに環境変数を使用する場合は、次のコマンドで各変数を設定します。

export GOOGLE_ADS_CLIENT_ID="INSERT_CLIENT_ID_HERE"
export GOOGLE_ADS_CLIENT_SECRET="INSERT_CLIENT_SECRET_HERE"
export GOOGLE_ADS_REFRESH_TOKEN="INSERT_REFRESH_TOKEN_HERE"
export GOOGLE_ADS_LOGIN_CUSTOMER_ID="INSERT_LOGIN_CUSTOMER_ID_HERE"

ランタイムにプログラムで情報を渡すこともできます。

client = Google::Ads::GoogleAds::GoogleAdsClient.new do |config|
  config.client_id = 'INSERT_CLIENT_ID_HERE'
  config.client_secret = 'INSERT_CLIENT_SECRET_HERE'
  config.refresh_token = 'INSERT_REFRESH_TOKEN_HERE'
  config.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE'
end

詳しくは、マルチユーザー認証のワークフロー ガイドを参照してください。Ruby クライアント ライブラリには、参照用のコード例が含まれています。GenerateUserCredentials コマンドライン コードの例は、実行時にユーザー認証を取得して、ユーザーの代わりに Google 広告アカウントを管理する方法を示しています。このコード例は、ユーザー認証を必要とするデスクトップ アプリを構築する際の参考として使用できます。

複数のアカウントを管理する

ユーザーが複数の Google 広告アカウントを管理することはよくあります。アカウントに直接アクセスする場合もあれば、Google 広告クライアント センター（MCC）アカウントを使用する場合もあります。Ruby クライアント ライブラリには、このようなケースを処理する方法を示す次のコード例が用意されています。

  1. GetAccountHierarchy コード例 では、Google 広告 MCC アカウントに属するすべてのアカウントのリストを取得する方法を示します。
  2. ListAccessibleCustomers コード例は、ユーザーが直接アクセスできるすべてのアカウントのリストを取得する方法を示しています。これらのアカウントは、login_customer_id 設定の有効な値として使用できます。

アプリケーションのデフォルト認証情報

Ruby クライアント ライブラリ（v36.1.0 以降）は、アプリケーションのデフォルト認証情報（ADC）を使用した認証もサポートしています。これにより、アプリケーション構成内で OAuth 2.0 情報を構成しなくても、アプリケーションのデフォルトの認証情報を設定できます。

これは、必要な OAuth 2.0 スコープにアクセスできる同じ認証情報を再利用できるため、ローカル開発やさまざまな Google API に対する開発に特に便利です。

Google Ads API の場合、アプリケーションのデフォルト認証情報が https://www.googleapis.com/auth/adwords OAuth 2.0 スコープにアクセスできることを確認します。

アプリケーションのデフォルト認証情報を使用するには、Google Cloud コマンドライン ツールを使用して ADC の認証を行います。

gcloud auth application-default login

このコマンドを実行すると、ウェブブラウザが開き、Google アカウントの認証フローが完了します。承認されると、認証情報が標準の場所に保存されます。次に、ADC を使用するようにアプリケーションを更新する必要があります。

google_ads_config.rb ファイルをホーム ディレクトリにコピーし、use_application_default_credentials を true に設定します。

# You can also authenticate using Application Default Credentials (ADC).
# To understand how ADC discovers credentials in a given environment, see:
# https://developers.google.com/identity/protocols/application-default-credentials
c.use_application_default_credentials = true

この情報をファイルに保存したくない場合は、環境変数を使用できます。GOOGLE_ADS_USE_APPLICATION_DEFAULT_CREDENTIALS を設定します。

export GOOGLE_ADS_USE_APPLICATION_DEFAULT_CREDENTIALS="true"

また、実行時にプログラムで情報を渡すこともできます。Ruby コードでクライアントを初期化するときに、config.use_application_default_credentials = true を設定し、明示的な OAuth 2.0 認証情報を指定しないでください。ライブラリは、Google Cloud コマンドライン ツールで設定された認証情報を自動的に検出して使用します。

# Initialize the client using Application Default Credentials.
client = Google::Ads::GoogleAds::GoogleAdsClient.new do |config|
  config.use_application_default_credentials = true

  # Optional: Specify a login customer ID if you are accessing accounts
  # through a manager account.
  # config.login_customer_id = 'YOUR_LOGIN_CUSTOMER_ID'

  # Do NOT include client_id, client_secret, or refresh_token here.
end

Ruby クライアント ライブラリを構成するために使用できるオプションの詳細については、構成ページをご覧ください。