設定

構成は Config クラスを使用して行います。このクラスには複数のバージョンからアクセスできます。 たとえば、構成ファイルの作成、作成時に値の指定、 値を読み込むことができます。

構成ファイル

1 対 1 の google_ads_config.rb クライアントをインスタンス化する際に使用するファイルを指定します。

インスタンス化時に引数を使用しない場合:

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

この場合、ライブラリは GOOGLE_ADS_CONFIGURATION_FILE_PATH 環境変数。変数の値が 未設定の場合、ライブラリは HOME ディレクトリでファイルを探します。

または、パスを指定することもできます。

client = Google::Ads::GoogleAds::GoogleAdsClient.new("path/to/file.rb")

その場合、クライアントはそのファイルパスでファイルを探します。

このファイルを生成する最も簡単な方法は、google_ads_config.rb を GitHub リポジトリを確認し、更新トークン、クライアント ID、 クライアント シークレットです。

動的構成

この構成は、ライブラリをインスタンス化する際に動的に設定できます。 あるいはその後も同様です。

client = Google::Ads::GoogleAds::GoogleAdsClient.new do |config|
  config.client_id = 'INSERT_CLIENT_ID_HERE'
  # ... more configuration
end

インスタンス化後に構成を変更することもできます。

client.configure do |config|
  config.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE'
  # ... more configuration
end

構成フィールド

Config オブジェクトは、次のフィールドをサポートしています。

一般フィールド:

  • refresh_token: OAuth 更新トークン。
  • client_id: OAuth クライアント ID。
  • client_secret: OAuth クライアント シークレット。
  • developer_token: API にアクセスするための開発者トークン。
  • login_customer_id: 詳しくは、 login-customer-id のドキュメントをご覧ください。

ロギング フィールド。詳しくは、ロギングガイドをご覧ください。

  • log_level: ログに記録する最小ログレベルのメッセージ。たとえば 'DEBUG' を指定すると、すべてのログメッセージが確実に表示されます。また、 'INFO' では DEBUG メッセージが除外されますが、その他のメッセージはすべて表示されます。
  • log_target: ログの出力先（STDERR など）。
  • logger: 独自のカスタム ロガーを指定します。これを指定すると、両方の広告が log_level と log_target。

環境変数

クライアント ライブラリは、環境変数を使用して構成できます。 デフォルトで読み込まれるため、追加の呼び出しが必要になるため、 する必要があります。環境変数の一覧をご覧ください。 でサポート 。

環境変数を Config に読み込むには、load_environment_config を呼び出します。

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

この関数が呼び出されるたびに、環境変数の現在の状態が Config にあるものがすべて上書きされます。こちらの たとえば、デフォルトの構成を使用しても、固有の構成をオーバーライドできます。 環境変数を使用して値を指定することも、完全に 使用します。

Ruby では、すべてのライブラリでサポートされている環境変数に加え、 ライブラリには、次の 2 つの変数が追加されています。

  • GOOGLE_ADS_RUBY_LOG_LEVEL: 上記の log_level。
  • GOOGLE_ADS_RUBY_HTTP_PROXY: HTTP プロキシを指定します。