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

Utilisez le kit d'outils API Integration and 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 basés sur l'IA sont particulièrement adaptés pour vous aider dans les opérations suivantes :

  • Traduction et migration de 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 de l'API Google.
  • Génération de code : génère des extraits de code pour diverses tâches Merchant API dans des langages tels que Python, Java, PHP et d'autres langages.
  • 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'outils API Integration and Code Assist 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 au codage tels que Gemini, Claude, ChatGPT, Grok et de les doter du serveur MCP de la documentation pour les développeurs de Merchant API ou des compétences de l'agent Merchant API pour les rendre plus ancrés tout en accélérant la vélocité 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 Merchant API

Obtenez des informations contextuelles sur Merchant API 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 codage des informations clés issues de la documentation officielle de l'API Google. Pour en savoir plus sur le protocole lui-même, consultez la norme Model Context Protocol.

Fonctionnement

Lorsque vous posez une question sur Merchant API à l'assistant de codage de votre IDE compatible avec MCP, 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 spécialisé de génération augmentée par récupération (RAG). Un système RAG est un système qui améliore la qualité des réponses des LLM en les connectant à des sources de connaissances externes et à jour. Votre assistant peut ainsi 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 codage envoie une requête 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 Merchant API.
  4. Le service renvoie des extraits faisant autorité en tant que contexte à votre assistant de codage.
  5. Votre assistant de codage exploite ce contexte pour générer une réponse fondé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 protocole Model Context Protocol avec transport HTTP diffusable.

2. Configurer le point de terminaison

Pour connecter votre IDE ou votre assistant de codage à MCP, utilisez les détails du point de terminaison distant fournis, qui peuvent vous obliger à saisir l'URL directe du service ou la définition MCP, en fonction de la configuration de votre outil :

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 à l'agent (facultatif)

Pour permettre à votre agent de traduire directement du code à l'aide de MCP, fournissez-lui les instructions système : 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 votre outil, vous pouvez fournir ces instructions dans la configuration des instructions système ou en tant que 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 products.insert de Content API for Shopping vers Merchant API.

Prompt de l'utilisateur :

"Migrer le code products.insert vers Merchant API"

En fournissant à votre agent des instructions système et un accès à MCP, votre agent peut traduire le code Content API for Shopping en code Merchant API directement dans votre IDE. Dans ce cas, il identifiera productInputs.insert comme l'appel équivalent et mappera les attributs de produit de l'ancien format au 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.

Prompt de l'utilisateur :

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

Le service MCP fournit un contexte à partir 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 le nouveau nom de l'API, accounts.issues.

Scénario 3 : Trouver un exemple de code

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

Prompt de l'utilisateur :

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

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

Scénario 4 : Comprendre les concepts de l'API

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

Prompt de l'utilisateur :

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

Le service MCP renvoie le contexte de la documentation sur la ressource products et des guides pertinents. Votre assistant peut ensuite expliquer comment utiliser la méthode accounts.productInputs.insert et 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 Merchant API ?"

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, telles que l'utilisation d'un compte de service pour les interactions de 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

Merchant API introduit de nouveaux modèles, tels que les requêtes par lot, qui diffèrent de Content API for Shopping. Content API for 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.

Prompt de l'utilisateur :

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

Le service MCP récupère le contexte de Refactor code for concurrent requests qui explique que les méthodes custombatch dédiées n'existent pas dans Merchant API. Au lieu de cela, il fournit de la documentation sur l'utilisation du traitement par lot HTTP avec un Content-Type de multipart. Votre assistant peut ensuite expliquer comment créer une seule requête HTTP contenant plusieurs appels d'API, envoyée au point de terminaison https://merchantapi.googleapis.com/batch/{sub-api}/v1, et fournir un exemple de structure de la requête multipart. 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 rapport de Content API for Shopping vers Merchant API.

Prompt de l'utilisateur :

"Migrer cette requête de rapport de Content API vers Merchant API : 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 dernière documentation de référence sur les rapports, les guides pour les développeurs et les guides de migration. Sur la base de ces informations, il transforme la requête en la nouvelle structure et met à jour les champs avec leurs nouveaux noms et valeurs.

Compétences de l'agent Merchant API

La spécification des compétences de l'agent est une norme ouverte adoptée par les outils de développement d'IA. Utilisez les compétences de l'agent pour améliorer votre expérience de développement et optimiser à la fois la migration de Content API for Shopping et la création de nouvelles intégrations. Les compétences de l'agent Merchant API regroupent des connaissances et des outils spécifiques à un domaine pour améliorer les capacités des agents d'IA et fournir une assistance d'expert à la demande pour les requêtes de documentation, la génération de code et le dépannage.

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

Fonctionnement

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

  • Configuration nulle : gère automatiquement les connexions au serveur MCP, ce qui élimine le besoin de configuration manuelle du point de terminaison.
  • Workflows d'experts : affine les prompts des utilisateurs en requêtes optimisées pour extraire 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 de sortie améliorée : fournit des instructions pour mettre en forme et structurer le résultat afin d'obtenir des réponses exploitables, lisibles et cohérentes.

Exemple de workflow :

  1. Vous posez une question sur Merchant API dans un outil de développement d'IA.
  2. La compétence de l'agent Merchant API analyse votre intention, formule une requête précise et applique ses connaissances procédurales à la requête.
  3. La compétence de l'agent envoie une requête de contexte au serveur MCP de la documentation pour les développeurs de Merchant API 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 Merchant API.
  5. Votre agent d'IA exploite 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 :

  • Prérequis pour les outils tels que l'outil de ligne de commande Antigravity.
  • Activation de la prise en charge des compétences de l'agent dans l'outil de votre choix.
  • Installation de la compétence mapi-developer-assistant à partir du dépôt GitHub, comme indiqué dans le fichier README.
  • Vérification de 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 installée et activée dans vos outils de développement d'IA, la compétence mapi-developer-assistant est généralement activée automatiquement lorsque vous posez des questions liées à Merchant API.

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

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

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

"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 Merchant API ?"

Sources de la base de connaissances

Le service MCP crée 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 pour les développeurs et du dépôt d'exemples de code, y compris :