Configuration

La bibliothèque cliente PHP de l'API Google Ads fournit plusieurs paramètres de configuration que vous pouvez utiliser pour personnaliser le comportement de la bibliothèque.

Fichier de configuration

Vous pouvez stocker la plupart de ces paramètres de configuration dans des fichiers de configuration INI et les utiliser lors de l'instanciation des clients, par exemple google_ads_php.ini.

Les créateurs d'identifiants et de clients fournissent tous deux des méthodes fromFile pour charger les paramètres à partir de ces fichiers :

$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 aucun chemin de configuration n'est fourni en tant qu'argument, les méthodes fromFile sont chargées à partir du chemin de configuration par défaut, qui est le suivant :

  1. Valeur de la variable d'environnement nommée GOOGLE_ADS_CONFIGURATION_FILE_PATH, si elle est définie.
  2. Sinon, le fichier google_ads_php.ini se trouve dans votre répertoire HOME.
$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile()
    ->build();

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

Configuration dynamique

Vous pouvez définir ces paramètres de configuration de manière dynamique lors de l'instanciation des clients :

$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 d'environnement de configuration

Vous pouvez définir certains paramètres de configuration à partir de variables d'environnement lors de l'instanciation des clients (voir les variables d'environnement standards).

Les générateurs d'identifiants et de clients fournissent tous deux des méthodes fromEnvironmentVariables pour charger les paramètres à partir des variables d'environnement.

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

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

Champs de configuration

Les paramètres de configuration sont compatibles avec plusieurs champs organisés en catégories :

  1. Champs utilisés par OAuth2TokenBuilder :
    • Mode Application :
      • [OAUTH2] clientId : votre ID client OAuth2.
      • [OAUTH2] clientSecret : votre code secret client OAuth2.
      • [OAUTH2] refreshToken : votre jeton d'actualisation OAuth2.
    • Mode compte de service :
      • [OAUTH2] jsonKeyFilePath : chemin d'accès à la clé JSON.
      • [OAUTH2] scopes : les habilitations OAuth2 (par défaut, https://www.googleapis.com/auth/adwords dans v32.1.0 et versions ultérieures ; obligatoires dans les versions antérieures à v32.1.0 ou lorsque vous utilisez des habilitations personnalisées ; fromEnvironmentVariables() ne les lit pas à partir d'une variable d'environnement).
      • [OAUTH2] impersonatedEmail : adresse e-mail facultative à emprunter lors de l'utilisation de la délégation au niveau du domaine Google Workspace.
    • Mode Identifiants par défaut de l'application :
      • Lorsque les champs "Mode Application" et "Mode Compte de service" ne sont pas définis, OAuth2TokenBuilder revient automatiquement aux identifiants par défaut de l'application (ADC).
  2. Champs utilisés par GoogleAdsClientBuilder :
    • [GOOGLE_ADS] developerToken : (Arrêt le 9 septembre 2026) Votre jeton de développeur de l'API Google Ads. Cette valeur est facultative et ignorée par les serveurs d'API, quelle que soit la version de la bibliothèque cliente. Elle sera refusée dans une prochaine version majeure de l'API Google Ads.
      • v35.0.0 et versions ultérieures : non requis lors de l'initialisation du client (GoogleAdsClientBuilder a supprimé la validation locale du jeton de développeur côté client).
      • Versions antérieures à v35.0.0 : requises par la validation de la configuration côté client local.
    • [GOOGLE_ADS] loginCustomerId : ID du client autorisé à utiliser dans la requête.
    • [GOOGLE_ADS] linkedCustomerId : ID client associé.
    • [GOOGLE_ADS] endpoint : point de terminaison du serveur de l'API Google Ads alternatif et facultatif.
    • [LOGGING] logFilePath : chemin d'accès à la sortie de journalisation.
    • [LOGGING] logLevel : niveau de journalisation.
    • [CONNECTION] proxy : URL du serveur proxy utilisé pour la connectivité Internet.
    • [CONNECTION] transport : transport réseau (grpc ou rest).
    • [CONNECTION] grpcChannelIsSecure : indique si le canal gRPC est sécurisé.
    • [CONNECTION] grpcChannelCredential : identifiants du canal gRPC.
    • [CONNECTION] unaryMiddlewares : middlewares unaires.
    • [CONNECTION] streamingMiddlewares : middlewares de streaming.
    • [CONNECTION] grpcInterceptors : intercepteurs gRPC.

Validation de la configuration

Les paramètres de configuration sont vérifiés lors de l'instanciation des clients, et des exceptions sont générées lorsqu'ils ne sont pas valides. Voici les règles de validation :

  1. Les champs [OAUTH2] ne doivent pas être définis simultanément pour le mode Application et le mode Compte de service.
  2. [OAUTH2] jsonKeyFilePath doit être défini lorsque vous utilisez le mode Compte de service (dans les versions antérieures à v32.1.0, [OAUTH2] scopes doit également être défini ; dans v32.1.0 et les versions ultérieures, scopes est défini par défaut sur https://www.googleapis.com/auth/adwords).
  3. [OAUTH2] clientId, [OAUTH2] clientSecret et [OAUTH2] refreshToken doivent être définis lorsque vous utilisez le mode Application.
  4. Dans les versions antérieures à v35.0.0, [GOOGLE_ADS] developerToken est vérifié par la validation locale côté client (dans v35.0.0 et les versions ultérieures, [GOOGLE_ADS] developerToken n'est pas requis).
  5. Si elles sont définies, [GOOGLE_ADS] loginCustomerId et [GOOGLE_ADS] linkedCustomerId doivent être des nombres positifs.
  6. Si elle est définie, [CONNECTION] proxy doit être une URL valide (voir le filtre FILTER_VALIDATE_URL).
  7. Si elle est définie, [LOGGING] logLevel doit être un niveau de journalisation PSR valide en majuscules, tel que INFO.
  8. Si elle est définie, [CONNECTION] transport doit être grpc ou rest.
  9. Si [CONNECTION] transport est défini sur grpc, le transport gRPC doit être compatible avec l'environnement (consultez le guide de transport).
  10. [CONNECTION] grpcChannelIsSecure doit être défini sur true lorsque [CONNECTION] transport n'est pas défini sur grpc (les connexions REST nécessitent toujours HTTPS).
  11. [CONNECTION] grpcChannelCredential ne peut être défini que lorsque [CONNECTION] transport est défini sur grpc.
  12. [CONNECTION] grpcChannelCredential ne peut être défini que lorsque [CONNECTION] grpcChannelIsSecure est true.