Intégration d'API et boîte à outils Code Assist

Utilisez le kit d'outils d'intégration d'API et Code Assist pour accélérer votre migration vers Merchant API et créer de nouvelles intégrations avec des outils de développement basés sur l'IA.

Présentation

Lorsque vous migrez de Content API for Shopping vers Merchant API ou que vous créez une intégration, vous devez comprendre les nouvelles structures de service, les noms de ressources et les méthodes. Les outils de développement optimisés par l'IA sont particulièrement adaptés pour vous aider dans les opérations suivantes :

  • Traduction et migration du code : vous aide à comprendre et à convertir l'ancien code Content API for Shopping au nouveau format Merchant API. Cela inclut le mappage des attributs de produit à la nouvelle structure et la mise à jour des fichiers de gestion des dépendances.
  • Expertise en documentation de l'API : fournit des explications claires sur les ressources, les méthodes, les champs, les quotas et les bonnes pratiques de Merchant API, en s'appuyant sur le contexte faisant autorité de la documentation officielle des API Google.
  • Génération de code : génère des extraits de code pour diverses tâches de la Merchant API dans des langages tels que Python, Java, PHP et d'autres.
  • Dépannage : vous aide à diagnostiquer et à corriger les erreurs d'API courantes.

Choisissez l'option qui correspond le mieux à votre environnement de développement et à votre cas d'utilisation spécifique. Utilisez le kit d'intégration d'API et d'assistance au codage pour adapter la configuration à votre workflow préféré :

Le schéma suivant illustre les options de configuration pour une migration de code assistée par l'IA dans les environnements de développement intégrés (IDE) les plus couramment utilisés, tels qu'Antigravity, Visual Studio Code, Cursor ou Copilot. Il est possible de configurer des assistants de codage tels que Gemini, Claude, ChatGPT et Grok, et de les optimiser avec le serveur MCP de la documentation pour les développeurs de l'API Merchant ou les compétences d'agent de l'API Merchant pour les rendre plus ancrés tout en accélérant la vitesse d'intégration.

(API Merchant) Diagramme de l'intégration de l'IA Code Assist

Serveur MCP de la documentation pour les développeurs de l'API Merchant

Obtenez des informations contextuelles sur l'API Merchant auprès de l'assistant de codage de votre choix. Dans votre IDE, vous pouvez désormais accéder à la documentation pour les développeurs à l'aide du service MCP (Model Context Protocol). Ce service fournit à votre assistant de programmation des informations clés issues de la documentation officielle des API Google. Pour en savoir plus sur le protocole lui-même, consultez la norme du protocole de contexte de modèle.

Fonctionnement

Lorsque vous posez une question à votre assistant de codage IDE compatible avec MCP concernant l'API Merchant, le service récupère les extraits de texte et de code les plus pertinents à partir de ressources officielles et les renvoie en tant que contexte à votre assistant de codage à l'aide d'un backend de génération augmentée par récupération (RAG) spécialisé. Un système RAG améliore la qualité des réponses des LLM en les connectant à des sources de connaissances externes et à jour. Votre assistant peut ainsi vous fournir des réponses précises et à jour sans que vous ayez à quitter votre environnement de développement.

Exemple de workflow :

  1. Vous posez une question à votre assistant de codage ou agent compatible avec MCP (par exemple, une question en langage naturel, une demande d'exemple de code ou une traduction de code).
  2. Votre assistant de programmation envoie une demande de contexte au point de terminaison MCP.
  3. Le service MCP recherche dans sa collection indexée de documentation, de guides et d'exemples de code officiels de l'API Merchant.
  4. Le service renvoie des extraits faisant autorité en tant que contexte à votre assistant de codage.
  5. Votre assistant de codage s'appuie sur ce contexte pour générer une réponse ancrée ou une tâche de traduction de code.

Premiers pas

Pour intégrer et utiliser MCP, procédez comme suit :

1. Utiliser un outil compatible

Ouvrez un IDE ou un assistant de codage compatible avec le Model Context Protocol avec transport HTTP en flux.

2. Configurer le point de terminaison

Pour connecter votre IDE ou votre assistant de codage à MCP, utilisez les informations fournies sur le point de terminaison distant. Selon la configuration de votre outil, vous devrez peut-être saisir l'URL directe du service ou la définition MCP :

Configurations :

Antigravity

Suivez les instructions de la documentation Antigravity.

"mcpServers": {
  "mapi-devdocs": {
    "command": "npx",
    "args": [
      "-y",
      "mcp-remote",
      "https://merchantapi.googleapis.com/devdocs/mcp"
    ]
  }
}

Visual Studio Code

Suivez les instructions de la documentation Visual Studio Code.

"servers": {
"mapi-devdocs": {
  "type": "http",
  "url": "https://merchantapi.googleapis.com/devdocs/mcp/"
  }
}

3. Ajouter des instructions pour l'agent (facultatif)

Pour permettre à votre agent de traduire directement du code à l'aide de MCP, fournissez-lui les instructions système du protocole de l'agent intégrateur Merchant. Ces instructions guident l'agent sur la manière d'utiliser correctement MCP pour la traduction de code. Selon l'outil, vous pouvez fournir ces instructions dans la configuration des instructions système ou sous forme de fichier de contexte supplémentaire pour l'agent.

Exemples de scénarios d'utilisation

MCP peut accélérer votre workflow dans les cas d'utilisation courants suivants :

Scénario 1 : Migrer le code products.insert

Vous pouvez demander à l'agent de migrer directement un code d'intégration Content API for Shoppingproducts.insert vers Merchant API.

Requête utilisateur :

"Migrer le code products.insert vers l'API Merchant"

En fournissant à votre agent des instructions système et un accès au MCP, vous lui permettez de traduire le code Content API for Shopping en code Merchant API directement dans votre IDE. Dans ce cas, elle identifiera productInputs.insert comme l'appel équivalent et mappera les attributs du produit de l'ancien format vers le nouveau format requis par Merchant API. Il peut également mettre à jour les importations requises et le fichier de gestion des dépendances (par exemple, requirements.txt, pom.xml ou package.json). Vous pouvez demander à l'agent d'effectuer les modifications sur place ou de créer un dossier.

Scénario 2 : Trouver une fonctionnalité équivalente

Vous disposez d'une application existante qui utilise Content API for Shopping et vous devez la mettre à jour. Vous pouvez poser des questions sur une ancienne méthode spécifique pour obtenir des informations sur la nouvelle implémentation et un exemple de code pertinent.

Requête utilisateur :

"Quel est l'équivalent de la méthode accountstatuses.get dans Content API for Shopping pour Merchant API ?"

Le service MCP fournit le contexte des guides de migration officiels et de la documentation de référence, ce qui permet à votre assistant de répondre de manière détaillée, y compris avec le nouveau nom de l'API, accounts.issues.

Scénario 3 : Trouver un exemple de code

Vous implémentez une nouvelle fonctionnalité et avez besoin d'un exemple pratique à suivre.

Requête utilisateur :

"Montre-moi un exemple de code Python pour ajouter un service de livraison à l'aide de l'API Merchant."

Le service MCP récupère des exemples de code pertinents à partir des dépôts GitHub officiels de Google et des guides du développeur. Votre assistant peut ensuite présenter un bloc de code complet et prêt à être adapté.

Scénario 4 : Comprendre les concepts liés aux API

Vous découvrez un nouveau concept ou vous souhaitez comprendre la structure d'une ressource ou le modèle global de l'API Merchant.

Requête utilisateur :

"Comment mettre à jour l'inventaire d'un produit à l'aide de Merchant API ?"

Le service MCP renvoie le contexte à partir de la documentation sur les ressources des produits et des guides pertinents. Votre assistant peut ensuite vous expliquer comment utiliser la méthode accounts.productInputs.insert et vous fournir la ressource produit partielle contenant uniquement le productId et les champs liés à l'inventaire que vous devez mettre à jour.

"Comment autoriser les appels de mon application avec l'API Merchant ?"

Le service MCP récupère le contexte des guides d'authentification officiels, qui couvrent différentes méthodes d'autorisation. Votre assistant peut ensuite expliquer les principales options disponibles, comme l'utilisation d'un compte de service pour les interactions serveur à serveur ou d'un ID client OAuth 2.0 lorsque vous agissez au nom d'un utilisateur.

Scénario 5 : S'adapter aux modifications de l'API

La Merchant API introduit de nouveaux modèles (comme le traitement par lot des requêtes) qui diffèrent de Content API for Shopping. Content API pour Shopping utilise des méthodes custombatch spécifiques, tandis que Merchant API utilise une fonctionnalité de traitement par lot HTTP générique intégrée.

Requête utilisateur :

"Quelle est la nouvelle façon d'effectuer un products.custombatch dans l'API Merchant ?"

Le service MCP récupère le contexte à partir de Refactor code for concurrent requests (Refactoriser le code pour les requêtes simultanées), qui explique que les méthodes custombatch dédiées n'existent pas dans l'API Merchant. Au lieu de cela, elle fournit de la documentation sur l'utilisation du traitement par lot HTTP avec une Content-Type de multipart. Votre assistant peut ensuite vous expliquer comment construire une requête HTTP unique contenant plusieurs appels d'API, envoyée au point de terminaison https://merchantapi.googleapis.com/batch/{sub-api}/v1, et vous fournir un exemple de structure de la requête multipartie. Cela transforme une tâche de migration potentiellement déroutante en un processus guidé.

Scénario 6 : Traduire une requête de rapport

Vous pouvez demander à l'agent de traduire une requête de création de rapports de Content API for Shopping vers Merchant API.

Requête utilisateur :

"Migre cette requête de reporting de l'API Content vers l'API Merchant : SELECT metrics.impressions, metrics.clicks, metrics.ctr FROM MerchantPerformanceView WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-30'"

Le service MCP récupère la documentation de référence la plus récente sur les rapports, les guides du développeur et les guides de migration. Sur la base de ces informations, il transforme la requête en nouvelle structure et met à jour les champs avec leurs nouveaux noms et valeurs.

Compétences de l'agent Merchant API

La spécification Agent Skills est une norme ouverte adoptée par les outils de développement de l'IA. Utilisez les compétences d'agent pour améliorer votre expérience de développeur et optimiser les deux, en migrant depuis Content API for Shopping et en créant de nouvelles intégrations. Les packages de compétences de l'agent Merchant API contiennent des connaissances et des outils spécifiques à un domaine pour améliorer les capacités des agents d'IA. Ils fournissent une assistance experte à la demande pour les questions concernant la documentation, la génération de code et le dépannage.

Les compétences de l'agent Merchant API sont compatibles avec divers outils et IDE de ligne de commande optimisés par l'IA, tels qu'Antigravity et Claude Code.

Fonctionnement

Les compétences de l'agent Merchant API fournissent un package d'expertise spécialisée basé sur la norme ouverte Agent Skills. Notre compétence d'agent mapi-developer-assistant sert de couche intelligente entre vos outils de développement d'IA et le serveur MCP de la documentation pour les développeurs de l'API Merchant. Il intègre une expertise du domaine et des conseils procéduraux, et présente les propriétés suivantes :

  • Configuration nulle : gère automatiquement les connexions au serveur MCP, ce qui élimine la nécessité de configurer manuellement les points de terminaison.
  • Workflows experts : affinent les requêtes des utilisateurs pour les optimiser et récupérer efficacement les informations les plus pertinentes.
  • Gestion du contexte et efficacité des jetons : utilise la "divulgation progressive" pour charger les informations à la demande et préserver la fenêtre de contexte de l'IA.
  • Mise en forme améliorée des résultats : fournit des instructions pour mettre en forme et structurer les résultats afin d'obtenir des réponses exploitables, lisibles et cohérentes.

Exemple de workflow :

  1. Vous posez une question sur l'API Merchant dans un outil de développement d'IA.
  2. La compétence d'agent Merchant API analyse votre intention, formule une requête précise et applique ses connaissances procédurales à la demande.
  3. La compétence de l'agent envoie une demande de contexte au serveur MCP de la documentation pour les développeurs de l'API Merchant, situé à l'adresse merchantapi.googleapis.com/devdocs/mcp/.
  4. Le service MCP recherche dans sa collection indexée de documentation, de guides et d'exemples de code officiels de l'API Merchant.
  5. Votre agent d'IA utilise ces informations pour fournir une réponse synthétisée et exploitable.

Premiers pas

Le fichier README des compétences de l'agent Merchant API fournit des instructions détaillées sur les points suivants :

  • Conditions requises pour les outils tels que l'outil de ligne de commande Antigravity.
  • Activez la prise en charge des compétences de l'agent dans l'outil de votre choix.
  • Installez la skill mapi-developer-assistant à partir du dépôt GitHub en suivant les instructions du fichier README.
  • Vérifiez l'installation.
  • Commandes de base pour la gestion des compétences.

Pour obtenir des instructions détaillées sur l'installation et la configuration de divers outils d'IA, y compris l'outil de ligne de commande Antigravity, Claude Code et d'autres, suivez les instructions du fichier README.

Exemples de prompts

Une fois la compétence mapi-developer-assistant installée et activée dans vos outils de développement d'IA, elle est généralement activée automatiquement lorsque vous posez des questions liées à l'API Merchant.

"Comment insérer un produit à l'aide de l'API Merchant en Python ?"

"Quel est l'équivalent Merchant API de la méthode Content API accountstatuses.get ?"

"Montre-moi un exemple Java pour gérer l'authentification avec l'API Merchant."

"J'obtiens une erreur "400 : requête incorrecte" avec une erreur de validation lorsque j'appelle productInputs.insert. Comment résoudre ce problème ?"

"Quelle est la différence entre ProductInput et Product dans l'API Merchant ?"

Sources de la base de connaissances

Le service MCP construit sa base de connaissances exclusivement à partir de sources publiques et officielles pour s'assurer que le contexte qu'il fournit est précis et fiable. Le service indexe l'intégralité du contenu du site officiel des développeurs et du dépôt d'exemples de code, y compris :