構成

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

Ads API クライアント ライブラリには、ライブラリの動作をカスタマイズするための設定がいくつかあります。

構成ファイル

クライアントをインスタンス化するときに使用する googleads.properties ファイルを指定できます。

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

my $api_client = Google::Ads::GoogleAds::Client->new();

HOME ディレクトリでファイルを探します。

あるいは、次のパスを指定することもできます。

my $properties_file = "/path/to/googleads.properties";

my $api_client = Google::Ads::GoogleAds::Client->new({
  properties_file => $properties_file
});

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

このファイルを生成する最も簡単な方法は、GitHub リポジトリから googleads.properties をコピーし、クライアント ID、クライアント シークレット、更新トークンが含まれるように変更することです。

動的構成

構成は、ライブラリをインスタンス化するときに(または後でも)動的に設定できます。

my $api_client = Google::Ads::GoogleAds::Client->new({
  developer_token   => "INSERT_DEVELOPER_TOKEN_HERE",
  login_customer_id => "INSERT_LOGIN_CUSTOMER_ID_HERE"
});

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

$api_client->set_login_customer_id("INSERT_LOGIN_CUSTOMER_ID_HERE");

また、API Client から OAuth2ApplicationsHandler オブジェクトを取得し、ランタイムでクライアント ID、クライアント シークレット、更新トークンを変更することもできます。

my $oauth2_applications_handler = $api_client->get_oauth2_applications_handler();
$oauth2_applications_handler->set_client_id("INSERT_CLIENT_ID");
$oauth2_applications_handler->set_client_secret("INSERT_CLIENT_SECRET");
$oauth2_applications_handler->set_refresh_token("INSERT_REFRESH_TOKEN");

構成環境変数

クライアントをインスタンス化する際に、環境変数から構成の一部の設定を行うことができます(全リストをご覧ください)。

Client モジュールには、環境変数から値を読み込む configure_from_environment_variables 関数が用意されています。

# Get the Google Ads Client. By default, any credentials will be read from
# ~/googleads.properties, or, if set, from the file specified in the
# GOOGLE_ADS_CONFIGURATION_FILE_PATH environment variable.
my $api_client = Google::Ads::GoogleAds::Client->new();

# Load the configuration from any set environment variables.
$api_client->configure_from_environment_variables();

設定に関する項目

構成プロパティでは、次のフィールドがサポートされています。

OAuth2ApplicationsHandler に保持されるフィールド:

  • client_id: OAuth2 クライアント ID。
  • client_secret: OAuth2 クライアント シークレット。
  • refresh_token: OAuth2 更新トークン。

API クライアントで保持されるフィールド

  • developer_token: API にアクセスするための開発者トークン。
  • login_customer_id: login-customer-id のドキュメントをご覧ください。
  • proxy: インターネット接続に使用するプロキシ サーバーの URL。