Installer et utiliser l'assistant pour les développeurs de l'API Google Ads

Prérequis

Avant de commencer, vérifiez que vous disposez des éléments suivants :

  1. Accès à l'API Google Ads :

    • Un jeton de développeur de l'API Google Ads.
    • Fichier de configuration Google Ads configuré avec votre jeton de développeur, vos identifiants OAuth 2.0 et votre ID 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.

  2. Logiciels :

    • Python 3.10 ou version ultérieure. Python est le langage par défaut. Vous devez donc l'installer et l'ajouter à votre chemin d'accès.
    • Outil de ligne de commande Google Antigravity installé.
    • jq (processeur JSON de ligne de commande). Le script d'installation tentera de l'installer s'il est manquant.

  3. Dépôt :

Premiers pas

  1. 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, l'accès à ce répertoire initialise automatiquement la session de l'assistant.)

  2. 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.sh

    Si vous utilisez Windows, exécutez le script PowerShell install.ps1.

  3. Configurez les identifiants : assurez-vous que votre fichier google-ads.yaml (ou son équivalent dans votre langue) est placé dans votre répertoire personnel.

  4. Interagissez 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 ?"
    • "Expliquez la différence entre click_view et impression_view."

  • Génération de code : générez 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."
    • "Obtiens tous les noms de groupes d'annonces activés pour l'ID de campagne 12345."
    • "Trouve les annonces refusées dans toutes les campagnes." Le code généré est automatiquement linté à l'aide de ruff et enregistré dans le répertoire saved/code/.

  • Exécution directe de l'API : exécutez les scripts Python en lecture seule générés directement dans un environnement virtuel isolé (.venv) et affichez les résultats mis en forme sous forme de tableaux dans votre terminal.

    • Dites simplement à 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 CSV : enregistrez les résultats tabulaires des appels d'API dans un fichier CSV.

    • "Enregistre les résultats dans un fichier CSV." Les fichiers sont enregistrés dans le répertoire saved/csv/.

  • 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 conversion hors connexion.

    • "Pourquoi n'y a-t-il aucun résultat pour ma requête ?"
    • "Résous les problèmes de mes 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.sh avec l'option --context_path pour enregistrer les fichiers de votre projet: none ./update.sh --context_path /path/to/your/codebase
    • Cela permet à l'assistant d'inclure la logique de votre application dans son raisonnement lors de la création de réponses ou de la génération de code dans la langue de votre choix.

Exemples de cas d'utilisation

  • Rapports :
    • "Obtiens 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 s'affichent dans l'UI. Comment puis-je résoudre ce problème à l'aide de l'API ?"
  • Apprentissage :
    • "/explique ce qu'est un ensemble partagé"
  • Génération de code
    • "Écris du code pour créer une campagne Performance Max pour company name."

Communauté et support

Consignes de contribution

Vos contributions sont les bienvenues. Pour obtenir des consignes, consultez le fichier CONTRIBUTING.md dans le dépôt GitHub.

Précédent
Qu'est-ce que l'assistant pour les développeurs de l'API Google Ads ?