配置

Google 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");

配置环境变量

实例化客户端时,您可以通过环境变量设置部分配置设置(请参阅详尽列表)。

客户端模块提供 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:用于互联网连接的代理服务器网址。