Configuración

La biblioteca cliente de PHP de la API de Google Ads proporciona varios parámetros de configuración que puedes usar para personalizar el comportamiento de la biblioteca.

Archivo de configuración

Puedes almacenar la mayoría de estos parámetros de configuración en archivos ini y usarlos cuando crees instancias de clientes, por ejemplo, google_ads_php.ini.

Los compiladores de credenciales y clientes proporcionan métodos fromFile para cargar la configuración de esos archivos:

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

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

Si no se proporciona una ruta de acceso de configuración como argumento, los métodos fromFile se cargan desde la ruta de acceso de configuración predeterminada, que es la siguiente:

1. Valor de la variable de entorno llamada GOOGLE_ADS_CONFIGURATION_FILE_PATH, si está configurada.
2. De lo contrario, el archivo google_ads_php.ini en tu directorio HOME.

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

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

Configuración dinámica

Puedes establecer estos parámetros de configuración de forma dinámica cuando crees instancias de clientes.

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

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

Variables de entorno de configuración

Puedes establecer algunos parámetros de configuración a partir de variables de entorno cuando creas instancias de clientes (consulta la lista exhaustiva).

Los compiladores de credenciales y clientes proporcionan métodos fromEnvironmentVariables para cargar la configuración desde variables de entorno:

Nota: Las variables de entorno no establecidas no se tienen en cuenta.

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

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

Campos de configuración

Nota: Los campos grpcChannelCredential, unaryMiddlewares, streamingMiddlewares y grpcInterceptors no se pueden establecer desde un archivo de configuración o una cadena, sino solo de forma dinámica.

Los parámetros de configuración admiten varios campos organizados en categorías.

1. Campos que usa OAuth2TokenBuilder:
   • Modo de la aplicación
     • [OAUTH2] clientId: Es tu ID de cliente de OAuth2.
     • [OAUTH2] clientSecret: Es el secreto de tu cliente de OAuth2.
     • [OAUTH2] refreshToken: Es tu token de actualización de OAuth2.
   • Modo de cuenta de servicio
     • [OAUTH2] jsonKeyFilePath: Es la ruta de acceso al archivo de clave JSON.
     • [OAUTH2] scopes: Son los permisos.
     • [OAUTH2] impersonatedEmail: Es el correo electrónico que se suplantará.
2. Campos que usa GoogleAdsClientBuilder:
   • [GOOGLE_ADS] developerToken: Es tu token de desarrollador para acceder a la API.
   • [GOOGLE_ADS] loginCustomerId: Es el ID del cliente autorizado que se usará en la solicitud.
   • [GOOGLE_ADS] linkedCustomerId: Es el ID del cliente vinculado.
   • [LOGGING] logFilePath: Es la ruta de acceso del archivo para el registro.
   • [LOGGING] logLevel: Es el nivel de registro.
   • [CONNECTION] proxy: Es la URL del servidor proxy que se usa para la conectividad a Internet.
   • [CONNECTION] transport: Es el transporte.
   • [CONNECTION] grpcChannelIsSecure: Indica si el canal de gRPC es seguro o no.
   • [CONNECTION] grpcChannelCredential: Son las credenciales del canal de gRPC.
   • [CONNECTION] unaryMiddlewares: Son los middlewares unarios.
   • [CONNECTION] streamingMiddlewares: Son los middlewares de transmisión.
   • [CONNECTION] grpcInterceptors: Son los interceptores de gRPC.

Validación de la configuración

La configuración se verifica cuando se crean instancias de los clientes y se arrojan excepciones cuando no es válida. Estas son las reglas:

1. Los campos [OAUTH2] no se deben configurar para el modo de aplicación y el modo de cuenta de servicio al mismo tiempo.
2. [OAUTH2] jsonKeyFilePath y [OAUTH2] scopes se deben configurar cuando se usa el modo de cuenta de servicio.
3. [OAUTH2] clientId, [OAUTH2] clientSecret y [OAUTH2] refreshToken se deben establecer cuando se usa el modo de aplicación.
4. [GOOGLE_ADS] developerToken siempre debe establecerse.
5. Si se configura, [GOOGLE_ADS] loginCustomerId y [GOOGLE_ADS] linkedCustomerId deben ser números positivos.
6. Si se configura, [CONNECTION] proxy debe ser una URL válida (consulta el filtro FILTER_VALIDATE_URL).
7. Si se configura, [LOGGING] logLevel debe ser un nivel de registro de PSR válido en letras mayúsculas, como INFO.
8. Si se configura, [CONNECTION] transport debe ser grpc o rest.
9. Si [CONNECTION] transport se establece en grpc, el entorno debe admitir el transporte de gRPC (consulta la guía transporte).
10. [CONNECTION] grpcChannelIsSecure debe ser true cuando [CONNECTION] transport no esté establecido como grpc.
11. [CONNECTION] grpcChannelCredential solo se puede configurar cuando [CONNECTION] transport se establece como grpc.
12. [CONNECTION] grpcChannelCredential solo se puede establecer cuando [CONNECTION] grpcChannelIsSecure es true.