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.

Nota: Los parámetros de configuración dinámicos especificados de forma explícita anulan los parámetros de configuración cargados desde las variables de entorno o los archivos de configuración INI, según el orden en el que se invocan los métodos del compilador.

Archivo de configuración

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

1. Es 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_HERE')
    ->withClientSecret('INSERT_CLIENT_SECRET_HERE')
    ->withRefreshToken('INSERT_REFRESH_TOKEN_HERE')
    ->build();

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

Variables de entorno de configuración

Puedes establecer algunos de los parámetros de configuración desde las variables de entorno cuando creas instancias de clientes (consulta las variables de entorno estándar).

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

Nota: No se tienen en cuenta las variables de entorno no configuradas.

$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, y solo se pueden configurar de forma dinámica.

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

1. Campos que usa OAuth2TokenBuilder:
   • Modo de aplicación:
     • [OAUTH2] clientId: Es tu ID de cliente de OAuth2.
     • [OAUTH2] clientSecret: Es tu secreto del 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 de la clave JSON.
     • [OAUTH2] scopes: Son los permisos de OAuth2 (el valor predeterminado es https://www.googleapis.com/auth/adwords en v32.1.0 y versiones posteriores; es obligatorio en versiones anteriores a v32.1.0 o cuando se usan permisos personalizados; fromEnvironmentVariables() no lo lee desde una variable de entorno).
     • [OAUTH2] impersonatedEmail: Es la dirección de correo electrónico opcional para suplantar la identidad cuando se usa la delegación de todo el dominio de Google Workspace.
   • Modo de credenciales predeterminadas de la aplicación:
     • Cuando no se configuran los campos de modo de aplicación ni de modo de cuenta de servicio, OAuth2TokenBuilder recurre automáticamente a las credenciales predeterminadas de la aplicación (ADC).
2. Campos que usa GoogleAdsClientBuilder:
   • [GOOGLE_ADS] loginCustomerId: Es el ID del cliente autorizado que se usará en la solicitud.
   • [GOOGLE_ADS] linkedCustomerId: Es el ID de cliente vinculado.
   • [GOOGLE_ADS] endpoint: Es el extremo alternativo opcional del servidor de la API de Google Ads.
   • [LOGGING] logFilePath: Es la ruta de acceso para el resultado del 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 de red (grpc o rest).
   • [CONNECTION] grpcChannelIsSecure: Indica si el canal de gRPC es seguro.
   • [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 los clientes y se arrojan excepciones cuando no son válidos. Las reglas de validación son las siguientes:

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 debe configurarse cuando se usa el modo de cuenta de servicio (en versiones anteriores a v32.1.0, también se debe configurar [OAUTH2] scopes; en v32.1.0 y versiones posteriores, scopes se establece de forma predeterminada en https://www.googleapis.com/auth/adwords).
3. [OAUTH2] clientId, [OAUTH2] clientSecret y [OAUTH2] refreshToken se deben configurar cuando se usa el modo 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 letras mayúsculas, como INFO.
7. Si se establece, [CONNECTION] transport debe ser grpc o rest.
8. Si [CONNECTION] transport se establece en grpc, el entorno debe admitir el transporte de gRPC (consulta la guía de transporte).
9. [CONNECTION] grpcChannelIsSecure debe ser true cuando [CONNECTION] transport no se establece en grpc (las conexiones REST siempre requieren HTTPS).
10. [CONNECTION] grpcChannelCredential solo se puede configurar cuando [CONNECTION] transport se establece como grpc.
11. [CONNECTION] grpcChannelCredential solo se puede configurar cuando [CONNECTION] grpcChannelIsSecure es true.