Prérequis
Avant de commencer, vérifiez que vous disposez des éléments suivants :
Accès à l'API Google Ads :
- Un jeton de développeur de l'API Google Ads.
- Un fichier de configuration Google Ads configuré avec votre jeton de développeur, vos identifiants OAuth 2.0 et votre numéro client, situé dans votre répertoire personnel. Consultez le guide de configuration de la bibliothèque cliente.
- Connaissance des concepts et de l'authentification de l'API Google Ads
Logiciel :
- Python 3.10 ou version ultérieure. Python étant le langage par défaut, vous devez l'avoir installé et sur votre chemin d'accès.
- L'outil de ligne de commande Google Antigravity est installé.
- jq (processeur JSON de ligne de commande). Le script d'installation tentera d'installer ce package s'il est manquant.
Dépôt :
- Clone local du dépôt
google-ads-api-developer-assistantdepuis GitHub.
- Clone local du dépôt
Premiers pas
Accédez au répertoire du projet :
cd <full path>/google-ads-api-developer-assistant(Remarque : Si l'intégration du shell Antigravity est activée, la saisie de ce répertoire initialisera automatiquement la session de l'assistant.)
Exécutez le script d'installation : ce script initialise l'environnement de développement et clone les bibliothèques clientes Google Ads requises (Python est installé par défaut).
./install.shSi vous utilisez Windows, exécutez le script PowerShell
install.ps1.Configurer les identifiants : assurez-vous que votre fichier
google-ads.yaml(ou son équivalent dans votre langue) est placé dans votre répertoire personnel.Interagir avec l'Assistant : une fois la session active, vous pouvez interagir avec l'Assistant en langage naturel directement dans votre terminal.
Principales fonctionnalités
Questions/réponses en langage naturel : posez des questions sur les fonctionnalités de l'API Google Ads, les bonnes pratiques ou des ressources spécifiques.
- "Quels sont les types de campagnes disponibles ?"
- "Comment filtrer par date dans GAQL ?"
- "Explique la différence entre click_view et impression_view."
Génération de code : générer des requêtes GAQL et des extraits de code Python exécutables.
- "Affiche-moi les campagnes qui ont généré le plus de conversions au cours des 30 derniers jours."
- "Récupère tous les noms de groupes d'annonces activés pour l'ID de campagne 12345."
- "Trouvez les annonces refusées dans toutes vos campagnes."
Le code généré est automatiquement linté à l'aide de
ruffet enregistré dans le répertoiresaved/code/.
Exécution directe de l'API : exécutez les scripts Python en lecture seule générés directement dans un environnement virtuel séquestré (
.venv) et affichez les résultats mis en forme sous forme de tableaux dans votre terminal.- Il vous suffit de dire à l'Assistant : Exécute le code ou Exécute le script.
- Pour des raisons de sécurité, les opérations de mutation (création, mise à jour, suppression) sont générées, mais jamais exécutées.
Exportation au format CSV : enregistrez les résultats tabulaires des appels d'API dans un fichier CSV.
- Enregistrez les résultats dans un fichier CSV.
Les fichiers sont enregistrés dans le répertoire
saved/csv/.
- Enregistrez les résultats dans un fichier CSV.
Les fichiers sont enregistrés dans le répertoire
Diagnostics et dépannage avancés : obtenez de l'aide pour les messages d'erreur, le comportement inattendu de l'API ou les problèmes de conversions hors connexion.
- "Pourquoi n'y a-t-il aucun résultat pour ma requête ?"
- "Résous les problèmes de conversions pour le client 123-456-7890." (Génère un rapport de diagnostic détaillé dans
saved/data/).
Contexte supplémentaire : ajoutez votre propre base de code ou des bibliothèques personnalisées pour le contexte.
- Utilisez le script
update.shavec l'option--context_pathpour enregistrer vos fichiers de projet :none ./update.sh --context_path /path/to/your/codebase - Cela permet à l'Assistant d'inclure la logique de votre application dans son raisonnement lorsqu'il crée des réponses ou génère du code dans la langue de votre choix.
- Utilisez le script
Exemples de cas d'utilisation
- Reporting :
- "Donne-moi les cinq principaux mots clés par coût pour le mois dernier pour le client 12345678."
- Structure du compte :
- "Liste tous les noms de campagnes et leurs ID."
- Dépannage :
- J'ai importé 100 conversions, mais seulement 78 apparaissent dans l'interface utilisateur. Comment puis-je déboguer cela à l'aide de l'API ?"
- Apprentissage :
- "/explain what a shared set is"
- Génération de code :
- "Écris du code pour créer une campagne Performance Max pour company name."
Communauté et support
- Problèmes GitHub : signalez des bugs, suggérez des fonctionnalités ou demandez de l'aide dans l'onglet Problèmes du dépôt.
- Discord : rejoignez la discussion sur le canal
#ads-api-ai-toolsdu serveur Discord de la communauté Google Advertising and Measurement. - Commentaires : faites-nous part de vos commentaires en remplissant ce formulaire d'enquête.
Consignes de contribution
Vos contributions sont les bienvenues ! Pour obtenir des consignes, consultez le fichier CONTRIBUTING.md dans le dépôt GitHub.