設定

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

YAML ファイルによる構成

リクエストに必要な認証情報を含む YAML ファイルを指定して、クライアントの初期化時に使用できます。このファイルには、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_ Namespace を追加する必要があります。たとえば、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)

設定に関する項目

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

一般的なフィールド（これらの名前は、YAML 構成と辞書構成のどちらを使用しても同じです）。

refresh_token: OAuth 更新トークン。
client_id: OAuth クライアント ID。
client_secret: OAuth クライアントシークレット。
developer_token: API へのアクセスに使用する開発者トークン。
login_customer_id: login-customer-id のドキュメントをご覧ください。
linked_customer_id: linked-customer-id のドキュメントをご覧ください。
json_key_file_path（旧 path_to_private_key_file）: ローカル秘密鍵ファイルのパス。これは、サービスアカウントを使用して認証する場合に使用されます。OAuth2 サービスアカウントのドキュメントをご覧ください。
impersonated_email（旧 delegate_account）: 委任として使用されるアカウントのメールアドレス。これは、サービスアカウントを使用した認証に使用されます。OAuth2 サービスアカウントのドキュメントをご覧ください。
logging: ロギング構成。ロギングフィールドの説明は次のとおりです。
http_proxy: プロキシのドキュメントをご覧ください。
use_proto_plus: proto-plus メッセージを使用するかどうか。Protobuf メッセージのドキュメントをご覧ください。

環境変数としての一般的なフィールド:

GOOGLE_ADS_CONFIGURATION_FILE_PATH
GOOGLE_ADS_REFRESH_TOKEN
GOOGLE_ADS_CLIENT_ID
GOOGLE_ADS_CLIENT_SECRET
GOOGLE_ADS_DEVELOPER_TOKEN
GOOGLE_ADS_LOGIN_CUSTOMER_ID
GOOGLE_ADS_LINKED_CUSTOMER_ID
GOOGLE_ADS_JSON_KEY_FILE_PATH（旧 GOOGLE_ADS_PATH_TO_PRIVATE_KEY_FILE）
GOOGLE_ADS_IMPERSONATED_EMAIL（旧 GOOGLE_ADS_DELEGATE_ACCOUNT）
GOOGLE_ADS_LOGGING
GOOGLE_ADS_HTTP_PROXY
GOOGLE_ADS_USE_PROTO_PLUS

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

version: スキーマバージョンを表す整数値。
disable_existing_loggers: アプリの他の場所で構成されたロガーを無効にするかどうか。
formatters: さまざまな形式設定ツールを定義する辞書。
handlers: ログの書き込み先と使用するフォーマッタを制御する、さまざまなハンドラを定義する辞書。
loggers: ハンドラやログレベルなど、さまざまなタイプのロガーを定義する辞書。