設定

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

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

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

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()

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

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

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

環境変数を使用した構成

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

dictload_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 構成と dict 構成のどちらを使用している場合も同じです)。

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

  • 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: ハンドラとログレベルを含む、さまざまな種類のロガーを定義する辞書。