Configuração

A biblioteca de cliente PHP da API Google Ads oferece várias configurações que podem ser usadas para personalizar o comportamento da biblioteca.

Arquivo de configuração

É possível armazenar a maioria dessas configurações em arquivos ini e usá-los ao instanciar clientes, por exemplo, google_ads_php.ini.

Os builders de credenciais e de cliente fornecem métodos fromFile para carregar configurações desses arquivos:

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

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

Se não houver um caminho de configuração fornecido como argumento, os métodos fromFile serão carregados do caminho de configuração padrão, que é:

1. O valor da variável de ambiente chamada GOOGLE_ADS_CONFIGURATION_FILE_PATH, se definida.
2. Caso contrário, o arquivo google_ads_php.ini no diretório HOME.

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

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

Configuração dinâmica

É possível definir essas configurações dinamicamente ao instanciar clientes.

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

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

Variáveis de ambiente de configuração

É possível definir algumas das configurações de configuração usando variáveis de ambiente ao instanciar clientes (consulte a lista completa).

Os builders de credenciais e de cliente fornecem métodos fromEnvironmentVariables para carregar configurações de variáveis de ambiente:

Observação: as variáveis de ambiente não definidas não são consideradas.

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

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

Campos de configuração

Observação: os campos grpcChannelCredential, unaryMiddlewares, streamingMiddlewares e grpcInterceptors não podem ser definidos em um arquivo ou string de configuração, mas apenas de forma dinâmica.

As configurações aceitam vários campos organizados em categorias.

1. Campos usados por OAuth2TokenBuilder:
   • Modo do aplicativo
     • [OAUTH2] clientId: seu ID do cliente OAuth2.
     • [OAUTH2] clientSecret: sua chave secreta do cliente OAuth2.
     • [OAUTH2] refreshToken: seu token de atualização do OAuth2.
   • Modo de conta de serviço
     • [OAUTH2] jsonKeyFilePath: o caminho do arquivo de chave JSON.
     • [OAUTH2] scopes: os escopos.
     • [OAUTH2] impersonatedEmail: o e-mail a ser personificado.
2. Campos usados por GoogleAdsClientBuilder:
   • [GOOGLE_ADS] developerToken: seu token de desenvolvedor para acessar a API.
   • [GOOGLE_ADS] loginCustomerId: o ID do cliente autorizado a ser usado na solicitação.
   • [GOOGLE_ADS] linkedCustomerId: o ID do cliente vinculado.
   • [LOGGING] logFilePath: o caminho do arquivo para registro.
   • [LOGGING] logLevel: o nível de registro.
   • [CONNECTION] proxy: o URL do servidor proxy usado para conectividade de Internet.
   • [CONNECTION] transport: o transporte.
   • [CONNECTION] grpcChannelIsSecure: indica se o canal gRPC é seguro ou não.
   • [CONNECTION] grpcChannelCredential: as credenciais do canal gRPC.
   • [CONNECTION] unaryMiddlewares: os middlewares unários.
   • [CONNECTION] streamingMiddlewares: os middlewares de streaming.
   • [CONNECTION] grpcInterceptors: os interceptors do gRPC.

Validação de configuração

As configurações são verificadas ao instanciar clientes, e exceções são geradas quando inválidas. Estas são as regras:

1. Os campos [OAUTH2] não podem ser definidos para o modo de aplicativo e o modo de conta de serviço ao mesmo tempo.
2. [OAUTH2] jsonKeyFilePath e [OAUTH2] scopes precisam ser definidos ao usar o modo de conta de serviço.
3. [OAUTH2] clientId, [OAUTH2] clientSecret e [OAUTH2] refreshToken precisam ser definidos ao usar o modo de aplicativo.
4. O campo [GOOGLE_ADS] developerToken precisa estar sempre definido.
5. Se definido, [GOOGLE_ADS] loginCustomerId e [GOOGLE_ADS] linkedCustomerId precisam ser números positivos.
6. Se definido, [CONNECTION] proxy precisa ser um URL válido (consulte o filtro FILTER_VALIDATE_URL).
7. Se definido, [LOGGING] logLevel precisa ser um nível de registro PSR válido em letras maiúsculas, como INFO.
8. Se definido, [CONNECTION] transport precisa ser grpc ou rest.
9. Se [CONNECTION] transport estiver definido como grpc, o transporte gRPC precisará ter suporte do ambiente (consulte o guia transporte).
10. [CONNECTION] grpcChannelIsSecure precisa ser true quando [CONNECTION] transport não estiver definido como grpc.
11. [CONNECTION] grpcChannelCredential só pode ser definido quando [CONNECTION] transport está definido como grpc.
12. [CONNECTION] grpcChannelCredential só pode ser definido quando [CONNECTION] grpcChannelIsSecure é true.