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 Puedes almacenar la mayoría de estos parámetros de configuración en ini archivos 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 configuración como argumento, los métodos fromFile se cargan desde la ruta de configuración predeterminada, que es la siguiente:

1. El 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)
    // ...
    ->build();

Variables de entorno de configuración

Puedes establecer algunos de los parámetros de configuración de las variables de entorno cuando crees instancias de clientes (consulta la lista exhaustiva).

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

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

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

Campos de configuración

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 tu secreto de 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 a la clave JSON.
     • [OAUTH2] scopes: Son los permisos.
     • [OAUTH2] impersonatedEmail: Es el correo electrónico que se suplantará.
2. Campos que usa GoogleAdsClientBuilder:
   • [GOOGLE_ADS] loginCustomerId: Es el ID del cliente autorizado para usar en la solicitud.
   • [GOOGLE_ADS] linkedCustomerId: Es el ID del cliente vinculado.
   • [LOGGING] logFilePath: Es la ruta de acceso 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

Los parámetros de configuración se verifican cuando se crean instancias de clientes y se generan excepciones cuando no son válidos. Estas son las reglas:

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