Nous vous recommandons d'utiliser la bibliothèque cliente avec Apache Maven (ou Gradle).
Créer un projet Maven/Gradle
Créez un projet Maven/Gradle dans l'IDE de votre choix. Nos artefacts sont publiés dans le dépôt central Maven.
La dépendance Maven est la suivante :
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads</artifactId>
<version>38.0.0</version>
</dependency>
La dépendance Gradle est la suivante :
implementation 'com.google.api-ads:google-ads:38.0.0'
Vous pouvez également compiler à partir de la source. Pour les besoins de ce guide, nous partons du principe que vous avez configuré un projet avec les dépendances requises disponibles.
Si vous compilez à partir de la source, assurez-vous d'activer le traitement des annotations dans votre IDE.
Obtenir des identifiants pour s'authentifier auprès de l'API
Pour accéder à l'API Google Ads, vous devez disposer d'identifiants OAuth et d'un jeton de développeur de l'API Google Ads. Cette section explique ce que sont ces données, comment elles sont utilisées et comment les obtenir.
Jeton de développeur (pour accéder à l'API)
Le jeton de développeur est associé à un compte administrateur et se trouve dans l'interface Web Google Ads.
Bien que le jeton de développeur soit associé à un compte administrateur, il ne donne pas accès à ce compte. En effet, le jeton de développeur accorde un accès à l'API en général, et l'accès au niveau du compte est configuré via OAuth.
Identifiants OAuth (pour accéder aux comptes Google Ads)
Pour vous authentifier en tant qu'utilisateur de compte Google ayant accès à des comptes Google Ads, vous devez fournir un ensemble d'identifiants OAuth.
Deux flux OAuth sont généralement utilisés : les applications de bureau (installées) et les applications Web. La principale différence entre les deux est que les applications de bureau doivent ouvrir le navigateur système et fournir un URI de redirection local pour gérer les réponses du serveur d'autorisation de Google, tandis que les applications Web peuvent rediriger un navigateur tiers arbitraire pour effectuer l'autorisation et renvoyer les identifiants à votre serveur. La bibliothèque est également compatible avec le flux de compte de service moins utilisé.
- Si vous autorisez l'accès à l'aide de vos propres identifiants (flux de l'application pour ordinateur)
- Consultez le flux d'application de bureau OAuth. Cela inclut tous les détails dont vous avez besoin pour l'autorisation avec vos propres identifiants.
- Si vous autorisez l'accès en tant qu'utilisateur Google tiers (flux Web)
- Consultez le flux d'application Web OAuth. Cet exemple montre comment configurer l'autorisation OAuth pour des utilisateurs tiers arbitraires.
- Si vous vous authentifiez en tant qu'utilisateur d'un domaine Google Apps (flux de compte de service)
- Consultez le flux de compte de service OAuth. Cet exemple montre comment configurer l'autorisation OAuth pour les utilisateurs de domaines Google Apps.
Si vous accédez au compte client Google Ads via un compte administrateur Google Ads, vous devez également spécifier un numéro client de connexion, comme décrit ci-dessous.
Numéro client de connexion (pour accéder aux comptes Google Ads via un compte administrateur)
Vous pouvez éventuellement spécifier l'ID client d'un compte administrateur qui donne accès au compte de diffusion. Cette valeur doit être spécifiée si vous accédez au compte client via un compte administrateur. Il n'est pas nécessaire de spécifier tous les comptes administrateur dans le chemin d'accès au numéro client. Seul l'ID de l'administrateur de premier niveau que vous utilisez pour les autorisations d'accès est requis. Pour en savoir plus, consultez la documentation associée.
Configurer la bibliothèque cliente avec vos identifiants
Vous pouvez configurer la bibliothèque cliente à l'aide d'un fichier de configuration, de variables d'environnement ou de manière programmatique. Pour ce guide, nous allons utiliser l'approche du fichier de configuration et nous concentrer sur les flux pour ordinateur et Web. L'utilisation d'un fichier de configuration est généralement une bonne approche si vous ne disposez que d'un seul ensemble d'identifiants (par exemple, si vous gérez des comptes sous un seul responsable).
Créez un fichier ~/ads.properties avec le contenu suivant :
api.googleads.clientId=INSERT_CLIENT_ID_HERE
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE
Remplacez les espaces réservés par vos identifiants obtenus à l'étape précédente.
De plus, si votre jeton d'actualisation concerne un compte administrateur, vous devez spécifier le numéro client de ce compte en tant que client de connexion :
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Valider les identifiants
Pour nous assurer que tout est correctement configuré, nous allons exécuter l'exemple GetCampaigns.
Commencez par accéder au répertoire google-ads-examples.
cd google-ads-examples
Cet exemple nécessite un paramètre --customerId dont la valeur correspond à votre numéro client Google Ads sans tirets.
Pour exécuter avec Gradle :
./gradlew -q runExample --example="basicoperations.GetCampaigns --customerId INSERT_CUSTOMER_ID_HERE"
Découvrir d'autres exemples
Le package examples de google-ads-examples contient plusieurs exemples utiles. La plupart des exemples nécessitent des paramètres. Vous pouvez transmettre les paramètres en tant qu'arguments (recommandé) ou modifier les valeurs INSERT_XXXXX_HERE dans le code source. Pour afficher une déclaration d'utilisation pour un exemple, transmettez --help comme seul argument.
Avec Gradle :
./gradlew -q runExample --example="basicoperations.GetCampaigns --help"
Vous pouvez également utiliser la tâche listExamples dans Gradle pour lister tous les exemples, les exemples d'un sous-répertoire ou les exemples dont la description inclut un terme de recherche.
# List all examples:
./gradlew -q listExamples
# List examples in the 'basicoperations' subdirectory:
./gradlew -q listExamples --subdirectory='basicoperations'
# Search for examples where the description includes 'Performance Max':
./gradlew -q listExamples --searchTerm='Performance Max'