Obtenez des informations contextuelles sur l'API Merchant auprès de l'assistant de programmation de votre choix. Dans votre environnement de développement intégré (IDE), vous pouvez désormais accéder à l'intégration de la documentation pour les développeurs à l'aide du service MCP (Model Context Protocol). Ce service accélère votre développement pour les workflows d'intégration et de migration en fournissant à votre assistant de codage un contexte faisant autorité à partir 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.
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. Le service MCP simplifie ce processus en fournissant une documentation officielle et des exemples de code à votre assistant de codage.
Le service utilise un backend de génération augmentée par récupération (RAG) hautement spécialisé. Lorsque vous posez une question sur l'API Merchant à votre assistant de codage IDE compatible avec MCP, le service récupère les extraits de texte et de code les plus pertinents des ressources officielles de Google et les renvoie en tant que contexte à votre assistant de codage. Votre assistant peut ainsi vous fournir des réponses précises et à jour sans que vous ayez à quitter votre environnement de développement.
Fonctionnement
L'intégration de la documentation pour les développeurs à l'aide de MCP s'inscrit dans un workflow de développement moderne assisté par l'IA :
- Vous posez une question dans votre assistant de programmation ou agent compatible avec MCP. Il peut s'agir d'une question en langage naturel ou d'une demande d'exemple de code pour l'implémentation des méthodes de l'API Merchant.
- Votre assistant de codage envoie une demande de contexte au point de terminaison MCP.
- Le service MCP recherche les informations les plus pertinentes dans sa collection indexée de documentation, de guides et d'exemples de code officiels de l'API Merchant.
- Le service renvoie ces extraits faisant autorité comme contexte à votre assistant de programmation.
- Votre assistant de programmation utilise ce contexte de haute qualité pour générer une réponse précise et utile à votre question initiale.
Premiers pas
Pour utiliser MCP, vous avez besoin d'un IDE ou d'un assistant de codage compatible avec le protocole Model Context Protocol avec transport HTTP en flux continu.
Configuration du point de terminaison
Pour connecter votre outil au service, 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.
L'URL du service est la suivante :
MCP Server Name: "MAPI Docs MCP"
MCP Server URL: "https://merchantapi.googleapis.com/devdocs/mcp/"
Exemples de scénarios d'utilisation
MCP peut accélérer votre workflow dans les cas d'utilisation courants suivants.
Scénario 1 : Migrer un ancien appel d'API
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 détails sur la nouvelle implémentation et un exemple de code pertinent.
Requête de l'utilisateur :
"Quel est l'équivalent Merchant API de la méthode accountstatuses.get dans Content API for Shopping ?"
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 d'API, accounts.issues.
Scénario 2 : Trouver un exemple de code
Vous implémentez une nouvelle fonctionnalité et avez besoin d'un exemple pratique à suivre.
Requête de l'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 et des guides pour les développeurs officiels de Google. Votre assistant peut ensuite présenter un bloc de code complet et prêt à être adapté.
Scénario 3 : Comprendre les concepts de l'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 de l'utilisateur :
"Comment mettre à jour l'inventaire d'un produit à l'aide de l'API Merchant ?"
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 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 de serveur à serveur ou d'un ID client OAuth 2.0 lorsque vous agissez au nom d'un utilisateur.
Scénario 4 : S'adapter aux modifications de l'API
La Merchant API introduit de nouveaux modèles, tels que le traitement par lot des requêtes, qui diffèrent de Content API for Shopping. Content API for Shopping utilise des méthodes custombatch spécifiques, tandis que l'API Merchant utilise une fonctionnalité de traitement par lot HTTP générique intégrée.
Requête de l'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, il fournit de la documentation sur l'utilisation du traitement par lot HTTP avec un Content-Type de multipart. Votre assistant peut ensuite vous expliquer comment construire 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 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é.
Sources de la base de connaissances
Le service MCP constitue 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 :
- Site Web pour les développeurs de l'API Merchant : tous les guides, les documents de référence et la documentation.
- Service Apps Script de l'API Merchant : Exemple d'utilisation de l'API Merchant à partir d'Apps Script.
- Exemples de code officiels : tous les exemples de code officiels fournis par Google pour l'API Merchant du dépôt GitHub.
- Bibliothèques clientes : toutes les bibliothèques clientes officielles acceptées par le marchand