配置是使用 Config
类完成的。您可以在多个
例如编写配置文件、在创建时指定值,或
从环境变量加载值。
配置文件
您可以指定
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 库有两个额外的变量:
GOOGLE_ADS_RUBY_LOG_LEVEL
:如上文的log_level
。GOOGLE_ADS_RUBY_HTTP_PROXY
:指定 HTTP 代理。