Configuración

La biblioteca cliente de PHP de la API de Google Ads proporciona varios ajustes 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 creas 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 del archivo de configuración como argumento, los métodos fromFile se cargan desde la ruta del archivo de configuración predeterminada, que es la siguiente:

1. El valor de la variable de entorno llamada GOOGLE_ADS_CONFIGURATION_FILE_PATH, si se configura.
2. De lo contrario, es 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 definir estos ajustes de forma dinámica cuando creas 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 algunas opciones de configuración de las variables de entorno cuando creas instancias de clientes (consulta la lista exhaustiva).

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

Nota: Las variables de entorno no configuradas 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 string, sino solo de forma dinámica.

Los ajustes de configuración admiten varios campos organizados en categorías.

1. Campos usados por OAuth2TokenBuilder:
   • Modo de aplicación
     • [OAUTH2] clientId: Es el ID de cliente de OAuth2.
     • [OAUTH2] clientSecret: El 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 del archivo de claves Json.
     • [OAUTH2] scopes: Los permisos.
     • [OAUTH2] impersonatedEmail: El correo electrónico que usará otra persona
2. Campos usados por GoogleAdsClientBuilder:
   • [GOOGLE_ADS] developerToken: Es tu token de desarrollador para acceder a la API.
   • [GOOGLE_ADS] loginCustomerId: Es el ID de cliente de acceso.
   • [GOOGLE_ADS] linkedCustomerId: El ID de cliente vinculado.
   • [LOGGING] logFilePath: La ruta del archivo para el registro.
   • [LOGGING] logLevel: El nivel de registro
   • [CONNECTION] proxy: 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: Las credenciales del canal de gRPC.
   • [CONNECTION] unaryMiddlewares: Los middlewares unarios.
   • [CONNECTION] streamingMiddlewares: Los middlewares de transmisión.
   • [CONNECTION] grpcInterceptors: Los interceptores de gRPC.

Validación de la configuración

La configuración se verifica cuando se crean instancias de clientes y se muestran excepciones cuando no son válidas. Estas son las reglas:

1. No se deben configurar los campos [OAUTH2] para el modo de aplicación y el modo de cuenta de servicio al mismo tiempo.
2. [OAUTH2] jsonKeyFilePath y [OAUTH2] scopes deben configurarse cuando se usa el modo de cuenta de servicio.
3. Se deben configurar [OAUTH2] clientId, [OAUTH2] clientSecret y [OAUTH2] refreshToken cuando se usa el modo de aplicación.
4. Siempre se debe establecer [GOOGLE_ADS] developerToken.
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 PPS válido en mayúsculas, como INFO.
8. Si se configura, [CONNECTION] transport debe ser grpc o rest.
9. Si [CONNECTION] transport está configurado como grpc, el transporte de gRPC debe ser compatible con el entorno (consulta la guía transporte).
10. [CONNECTION] grpcChannelIsSecure debe ser true cuando [CONNECTION] transport no está configurado como grpc.
11. [CONNECTION] grpcChannelCredential solo se puede configurar cuando [CONNECTION] transport se configura como grpc.
12. [CONNECTION] grpcChannelCredential solo se puede configurar cuando [CONNECTION] grpcChannelIsSecure es true.