Configuración

Advertencia: A partir del 31 de marzo de 2024, la biblioteca cliente de la API de Google Ads para PHP ya no admitirá versiones de PHP anteriores a 8.1. Para garantizar un funcionamiento óptimo, te recomendamos que actualices tu versión de PHP antes de esa fecha.

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 de clientes proporcionan métodos fromFile para cargar la configuración desde 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 archivo de configuración como argumento, los métodos fromFile se cargan desde la ruta de acceso 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, el archivo google_ads_php.ini de 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 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 algunos de los ajustes de configuración desde las variables de entorno cuando creas instancias de clientes (consulta la lista exhaustiva).

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

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

$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 configurar 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 aplicación
     • [OAUTH2] clientId: Es el ID de cliente de OAuth2.
     • [OAUTH2] clientSecret: Tu secreto del cliente de OAuth2.
     • [OAUTH2] refreshToken: Es el token de actualización de OAuth2.
   • Modo de cuenta de servicio
     • [OAUTH2] jsonKeyFilePath: Es la ruta de acceso al archivo de claves JSON.
     • [OAUTH2] scopes: Los permisos
     • [OAUTH2] impersonatedEmail: Es el correo electrónico que se usará para robar la identidad.
2. Campos que usa GoogleAdsClientBuilder:
   • [GOOGLE_ADS] developerToken: Es el 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 de cliente vinculado.
   • [LOGGING] logFilePath: Es la ruta de acceso 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: Determina si el canal de gRPC es seguro o no.
   • [CONNECTION] grpcChannelCredential: Las credenciales del canal de gRPC.
   • [CONNECTION] unaryMiddlewares: Es el middleware unario.
   • [CONNECTION] streamingMiddlewares: Son los middlewares de transmisión.
   • [CONNECTION] grpcInterceptors: Los interceptores de gRPC.
3. [GAPIC] useGapicV2Source: Indica si se debe usar el código fuente de GAPIC v2 cuando se crean clientes de servicios.

Validación de la configuración

Se verifica la configuración cuando se crean instancias de clientes, y se producen excepciones cuando no son válidas. 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. Se deben configurar [OAUTH2] jsonKeyFilePath y [OAUTH2] scopes 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 establecen, [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 PRS válido en letras mayúsculas, como INFO.
8. Si se configura, [CONNECTION] transport debe ser grpc o rest.
9. Si [CONNECTION] transport se configura como grpc, el transporte de gRPC debe ser compatible con el entorno (consulta la guía sobre transporte).
10. [CONNECTION] grpcChannelIsSecure debe ser true cuando [CONNECTION] transport no se establezca en grpc.
11. [CONNECTION] grpcChannelCredential solo se puede configurar cuando [CONNECTION] transport se establece en grpc.
12. [CONNECTION] grpcChannelCredential solo se puede configurar cuando [CONNECTION] grpcChannelIsSecure es true.