配置

Google Ads API PHP 客户端库提供了多种配置设置，供您自定义库行为。

配置文件

您可以将其中的大多数配置设置存储在 ini 文件中，并在实例化客户端时使用，例如 google_ads_php.ini。

凭据和客户端构建器都提供 fromFile 方法以从此类文件加载设置：

$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->withOAuth2Credential($oAuth2Credential)
    ->build();

如果未提供配置文件路径作为参数，fromFile 方法将从默认配置文件路径（即：

1. 名为 GOOGLE_ADS_CONFIGURATION_FILE_PATH 的环境变量的值（如果已设置）。
2. 否则，位于 HOME 目录中的 google_ads_php.ini 文件。

$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile()
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->fromFile()
    ->withOAuth2Credential($oAuth2Credential)
    ->build();

动态配置

您可以在实例化客户端时动态设定这些配置设置。

$oAuth2Credential = (new OAuth2TokenBuilder())
    ->withClientId('INSERT_CLIENT_ID')
    // ...
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->withOAuth2Credential($oAuth2Credential)
    ->withDeveloperToken('INSERT_DEVELOPER_TOKEN_HERE')
    // ...
    ->build();

配置环境变量

您可以在实例化客户端时通过环境变量设定一些配置设置（请参阅详尽列表）。

凭据和客户端构建器都提供 fromEnvironmentVariables 方法以从环境变量加载设置：

注意：未设置的环境变量不会得到考虑。

$oAuth2Credential = (new OAuth2TokenBuilder())
    // ...
    ->fromEnvironmentVariables()
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->withOAuth2Credential($oAuth2Credential)
    // ...
    ->fromEnvironmentVariables()
    ->build();

配置字段

注意：无法从配置文件或字符串设置 grpcChannelCredential、unaryMiddlewares、streamingMiddlewares 和 grpcInterceptors 字段，只能动态设置。

配置设置支持按类别整理的多个字段。

1. OAuth2TokenBuilder 使用的字段：
   • 应用模式
     • [OAUTH2] clientId：您的 OAuth2 客户端 ID。
     • [OAUTH2] clientSecret：您的 OAuth2 客户端密钥。
     • [OAUTH2] refreshToken：您的 OAuth2 刷新令牌。
   • 服务帐号模式
     • [OAUTH2] jsonKeyFilePath：Json 密钥文件路径。
     • [OAUTH2] scopes：范围。
     • [OAUTH2] impersonatedEmail：要模拟的电子邮件。
2. GoogleAdsClientBuilder 使用的字段：
   • [GOOGLE_ADS] developerToken：用于访问 API 的开发者令牌。
   • [GOOGLE_ADS] loginCustomerId：登录客户 ID。
   • [GOOGLE_ADS] linkedCustomerId：关联的客户 ID。
   • [LOGGING] logFilePath：用于记录的文件路径。
   • [LOGGING] logLevel：日志记录级别。
   • [CONNECTION] proxy：用于互联网连接的代理服务器网址。
   • [CONNECTION] transport：传输。
   • [CONNECTION] grpcChannelIsSecure：gRPC 通道是否安全。
   • [CONNECTION] grpcChannelCredential：gRPC 渠道凭据。
   • [CONNECTION] unaryMiddlewares：一元中间件。
   • [CONNECTION] streamingMiddlewares：流式中间件。
   • [CONNECTION] grpcInterceptors：gRPC 拦截器。

配置验证

系统会在实例化客户端时检查配置设置，并在无效时抛出异常。规则如下：

1. 不能同时为应用模式和服务帐号模式设置 [OAUTH2] 字段。
2. 使用服务帐号模式时，必须设置 [OAUTH2] jsonKeyFilePath 和 [OAUTH2] scopes。
3. 使用应用模式时必须设置 [OAUTH2] clientId、[OAUTH2] clientSecret 和 [OAUTH2] refreshToken。
4. 必须始终设置 [GOOGLE_ADS] developerToken。
5. 如果设置，[GOOGLE_ADS] loginCustomerId 和 [GOOGLE_ADS] linkedCustomerId 必须为正数。
6. 如果已设置，则 [CONNECTION] proxy 必须是有效网址（请参阅过滤条件 Filter_VALIDATE_网址）。
7. 如果设置了此标记，[LOGGING] logLevel 必须是以大写字母表示的有效 PSR 日志级别，例如 INFO。
8. 如果设置，[CONNECTION] transport 必须为 grpc 或 rest。
9. 如果 [CONNECTION] transport 设置为 grpc，则环境必须支持 gRPC 传输（请参阅指南传输）。
10. 当 [CONNECTION] transport 未设置为 grpc 时，[CONNECTION] grpcChannelIsSecure 必须为 true。
11. 仅当 [CONNECTION] transport 设置为 grpc 时，才能设置 [CONNECTION] grpcChannelCredential。
12. 仅当 [CONNECTION] grpcChannelIsSecure 为 true 时才能设置 [CONNECTION] grpcChannelCredential。