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 Google Ads configuré avec votre jeton de développeur, vos identifiants OAuth 2.0 et votre ID client , généralement 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'inclure dans votre chemin d'accès.
    • gemini-cli 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

  2. Exécutez le script de configuration : ce script configure gemini-cli pour qu'il utilise les fichiers de contexte GEMINI.md de l'assistant et les outils nécessaires.

    ./install.sh

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

  3. Démarrez gemini-cli :

    gemini

  4. Interagissez avec l'assistant : vous pouvez désormais poser des questions ou donner des commandes en langage naturel.

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.

    • "Affichez-moi les campagnes qui ont généré le plus de conversions au cours des 30 derniers jours."
    • "Obtenez tous les noms de groupes d'annonces activés pour l'ID de campagne 12345."
    • "Recherchez les annonces refusées dans toutes les campagnes." Le code généré est 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 à partir de gemini-cli et affichez les résultats mis en forme dans votre terminal. Une fois que l'assistant a généré le code, une invite s'affiche à l'écran :

To run this script, you will need to replace YOUR_CUSTOMER_ID with your actual
Google Ads customer ID and execute the following command in
your shell: <command>

Saisissez run. Le script s'exécutera dans le contexte de l'assistant si votre langage par défaut est Python, Ruby ou PHP. Les langages compilés ne s'exécuteront pas en raison des règles de sécurité.

  • 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/.

  • Aide à la résolution des problèmes : obtenez de l'aide concernant les messages d'erreur ou le comportement inattendu de l'API.

    • "J'ai reçu l'erreur 'AuthenticationError.OAUTH_TOKEN_INVALID'. Que dois-je faire ?"
    • "Pourquoi ma requête ne renvoie-t-elle aucun résultat ?"

  • Contexte supplémentaire : ajoutez votre base de code pour le contexte.

    • À partir de la version 2.3.0, utilisez l'indicateur context_dir pour inclure les fichiers de votre projet : ./update.sh --context_dir /path/to/your/codebase L'assistant peut ainsi inclure la logique de votre application dans son raisonnement lors de la création de réponses.
    • Cette fonctionnalité permet à l'assistant de générer des exemples de code enregistrés dans le langage de votre choix, même lorsqu'aucune bibliothèque cliente officielle n'est disponible.
    • Avant de demander la sortie de code, indiquez à l'assistant : write saved code examples in <language of your application>

Exemples de cas d'utilisation

  • Rapports :
    • "Obtenez les cinq principaux mots clés par coût pour le mois dernier pour le client 12345678."
  • Structure du compte
    • "Liste de tous les noms de campagnes et de leurs ID."
  • Résolution des problèmes
    • "J'ai importé 100 conversions, mais seulement 78 s'affichent dans l'UI. Comment résoudre ce problème à l'aide de l'API ? "
  • Apprentissage :
    • "/explain what a shared set is"
  • Génération de code
    • "Écrivez du code pour créer une campagne Performance Max pour company name."

Communauté et support

Consignes de contribution

Les 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 ?