設定

クライアントを構成する方法は複数あります。

認証構成

Google Ads API へのアクセスに必要な OAuth 認証情報を管理する方法は複数あります。選択するアプローチによって、使用する構成フィールドが異なります。詳細については、認証ガイドをご覧ください。

YAML ファイルを使用した構成

クライアントの初期化時に使用する YAML ファイルを指定できます。このファイルには、Google Ads API にリクエストを行うために必要な情報が含まれています。このファイルは、load_from_storage メソッドを使用してクライアントが初期化されるときにアクセスされます。このファイルを生成する最も簡単な方法は、GitHub リポジトリから google-ads.yaml の例をコピーし、開発者トークン、更新トークン、クライアント ID、クライアント シークレットなどの認証情報を含めるように変更することです。

パスを指定しない場合、ライブラリは $HOME ディレクトリで次のファイルを検索します。

from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage()

google-ads.yaml ファイルの場所を指定するには、呼び出すときにパスを文字列としてメソッドに渡します。

from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage("path/to/google-ads.yaml")

特定の環境変数を定義してパスを指定することもできます。

import os

os.environ["GOOGLE_ADS_CONFIGURATION_FILE_PATH"] = "path/to/google-ads.yaml"
from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage()

両方の値が指定されている場合（パスがメソッドに渡され、環境変数が存在する場合）、ライブラリはメソッドに渡されたパスを優先します。

環境変数を使用した構成

すべてのクライアント構成を環境変数として保存できます。環境変数は、クライアントの load_from_env メソッドを使用するときに読み取られます。環境変数は、google-ads.yaml ファイルで定義されているものと同じ名前ですが、すべて大文字で、GOOGLE_ADS_ 名前空間が接頭辞として付いている必要があります。たとえば、client_id は GOOGLE_ADS_CLIENT_ID として保存する必要があります。

環境変数は通常、$HOME ディレクトリにある .bashrc ファイルや .bash_profile ファイルなどの bash 構成ファイルで定義されます。コマンドラインを使用して定義することもできます。これらの手順は、 を使用していることを前提としています。別のシェルを使用している場合は、使用しているシェルで環境変数を設定する方法についてドキュメントを参照してください。bash

ターミナルを使用して .bashrc ファイルで環境変数を定義する基本的な手順は次のとおりです。

# Append the line "export GOOGLE_ADS_CLIENT_ID=1234567890" to
# the bottom of your .bashrc file.
$ echo "export GOOGLE_ADS_CLIENT_ID=1234567890" >> ~/.bashrc
# Update your bash environment to use the most recently updated
# version of your .bashrc file.
$ src ~/.bashrc

環境変数は、コマンドラインからターミナル インスタンスに直接設定することもできます。

$ export GOOGLE_ADS_CLIENT_ID=1234567890
$ echo $GOOGLE_ADS_CLIENT_ID
1234567890

load_from_env メソッドは、Python の組み込み os モジュールの environ 属性から構成データを読み込みます。例: os.environ["GOOGLE_ADS_CLIENT_ID"]

環境変数から構成を使用してクライアント インスタンスを初期化する方法の例を次に示します。

from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_env()

環境変数を使用して logging を構成するには、構成 値がサンプル google-ads.yaml 構成ファイルの YAML キーの構造と一致する JSON オブジェクトである必要があります。

.bashrc ファイルを使用して設定する方法の例を次に示します。

export GOOGLE_ADS_LOGGING='{
  "version": 1,
  "disable_existing_loggers": false,
  "formatters": {
    "default_fmt": {
      "format": "[%(asctime)s - %(levelname)s] %(message).5000s",
      "datefmt": "%Y-%m-%d %H:%M:%S"
    }
  },
  "handlers": {
    "default_handler": {
      "class": "logging.StreamHandler",
      "formatter": "default_fmt"
    }
  },
  "loggers": {
    "": {
      "handlers": ["default_handler"],
      "level": "INFO"
    }
  }
}'

YAML 文字列を使用した構成

YAML ファイルをメモリに読み込んだ場合は、初期化時にクライアントに直接提供できます。これを行うには、load_from_string メソッドを使用します。

from google.ads.googleads.client import GoogleAdsClient

with open("/path/to/yaml", "rb") as handle:
    yaml = handle.read()

client = GoogleAdsClient.load_from_string(yaml)

dict を使用した構成

dict を load_from_dict メソッドに直接渡すことができます。例:

from google.ads.googleads.client import GoogleAdsClient

credentials = {
    "developer_token": "abcdef123456",
    "refresh_token": "1//0abcdefghijklABCDEF",
    "client_id": "123456-abcdef.apps.googleusercontent.com",
    "client_secret": "aBcDeFgHiJkL"}

client = GoogleAdsClient.load_from_dict(credentials)

構成フィールド

クライアント ライブラリの構成では、次のフィールドがサポートされています。

認証

使用する認証アプローチに応じて、次のフィールド グループのいずれかを使用します。

  • アプリケーションのデフォルト認証情報を使用したシングルユーザー（ドキュメント）
    • use_application_default_credentials: ライブラリで認証にアプリケーションのデフォルト認証情報（ADC）を使用するかどうか。
  • OAuth トークンを使用したシングルユーザー（ドキュメント）
    • client_id: OAuth クライアント ID。
    • client_secret: OAuth クライアント シークレット。
    • refresh_token: OAuth 更新トークン。
  • サービス アカウント（ドキュメント）
    • json_key_file_path: ローカル秘密鍵ファイルへのパス。これは、サービス アカウントを使用して認証するために使用されます。

ライブラリの動作

これらのフィールドは、ライブラリの動作を決定します。

リクエスト レベルの構成

環境変数

環境変数を使用してライブラリを構成するには、次のものを使用します。

  • GOOGLE_ADS_CLIENT_ID
  • GOOGLE_ADS_CLIENT_SECRET
  • GOOGLE_ADS_CONFIGURATION_FILE_PATH
  • GOOGLE_ADS_DEVELOPER_TOKEN
  • GOOGLE_ADS_HTTP_PROXY
  • GOOGLE_ADS_JSON_KEY_FILE_PATH
  • GOOGLE_ADS_LINKED_CUSTOMER_ID
  • GOOGLE_ADS_LOGIN_CUSTOMER_ID
  • GOOGLE_ADS_LOGGING
  • GOOGLE_ADS_REFRESH_TOKEN
  • GOOGLE_ADS_USE_PROTO_PLUS
  • GOOGLE_ADS_USE_APPLICATION_DEFAULT_CREDENTIALS

ロギング構成

ロギング フィールド（logging 構成 フィールドの下にあるフィールド）は、ライブラリが logging 名前空間 のすべてのフィールドを logging.config.dictConfig メソッドに直接渡すため、logging.config 組み込みモジュール から直接派生します。詳細については、 ロギング ガイドをご覧ください。

  • version: スキーマ バージョンを表す整数値。
  • disable_existing_loggers: アプリケーションの他の場所で構成されたロガーを無効にするかどうか。
  • formatters: さまざまな種類のフォーマッタを定義するディクショナリ。
  • handlers: さまざまなハンドラを定義するディクショナリ。ログの書き込み先と使用するフォーマッタを制御します。
  • loggers: ハンドラとログレベルを含む、さまざまな種類のロガーを定義するディクショナリ。