从您选择的编码助理获取有关 Merchant API 的情境智能。在集成式开发环境 (IDE) 中,您现在可以使用 Model Context Protocol (MCP) 服务访问开发者文档集成。此服务通过为编码助理提供来自 Google 官方 API 文档的权威情境,加快了集成和迁移工作流的开发速度。
如需详细了解该协议本身,请参阅 Model Context Protocol 标准。
概览
从 Content API for Shopping 迁移到 Merchant API 或构建新的集成时,您需要了解新的服务结构、资源名称和方法。MCP 服务通过向编码助理提供官方文档和代码示例来简化此过程。
该服务利用高度专业化的检索增强生成 (RAG) 后端。当您向支持 MCP 的 IDE 编码助理询问有关 Merchant API 的问题时,该服务会从 Google's official resources 中检索最相关的文本和代码片段 ,并将其作为 情境返回给编码助理。这样,您的助理就可以提供准确、最新的答案,而您无需离开开发环境。
运作方式
使用 MCP 的开发者文档集成会集成到现代 AI 辅助开发工作流中:
- 您可以在与 MCP 兼容的编码助理或智能体中提出问题。这可以是自然语言问题、Merchant API 代码示例请求,甚至是将代码直接翻译为 Merchant API 的请求。
- 编码助理会向 MCP 端点发送情境请求。
- MCP 服务会搜索其索引的官方 Merchant API 文档、指南和代码示例集合,以查找最相关的信息。
- 该服务会将这些权威片段作为情境返回给编码助理。
- 编码助理会使用此高质量的情境来生成针对原始问题的准确且有用的答案,或执行代码翻译任务。
使用入门
如需使用 MCP,请按以下步骤操作:
1. 使用兼容的工具
打开支持 Model Context Protocol 和可流式传输的 HTTP 传输的 IDE 或编码助理。
2. 端点配置
如需将 IDE 或编码助理连接到 MCP,请使用提供的远程端点详细信息,这可能需要您输入直接服务网址或 MCP 定义(具体取决于工具的配置)。
服务网址为:
MCP Server Name: "MAPI Docs MCP"
MCP Server URL: "https://merchantapi.googleapis.com/devdocs/mcp/"
MCP Server Protocol: "http"
配置设置:
Antigravity
按照 Antigravity 文档 中的说明操作。
{
"mcpServers": {
"mapi-devdocs": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"https://merchantapi.googleapis.com/devdocs/mcp"
]
}
}
}
Visual Studio Code
按照 Visual Studio Code 文档 中的说明操作。
{
"servers": {
"mapi-devdocs": {
"type": "http",
"url": "https://merchantapi.googleapis.com/devdocs/mcp/"
}
}
}
3. 添加智能体说明(可选)
如需让智能体能够使用 MCP 直接翻译代码,请为其提供 系统说明:MerchantIntegrator 智能体 协议。 这些说明会指导智能体如何正确利用 MCP 进行代码翻译。根据您的工具,您可以在系统说明配置中提供这些说明,也可以将其作为智能体的其他上下文的描述文件提供。
使用场景示例
在以下常见使用场景中,MCP 可以加快您的工作流程。
场景 1:迁移 products.insert 代码
您可以要求智能体将 Content API for Shopping products.insert 集成代码直接迁移到 Merchant API。
用户提示:
“将
products.insert代码迁移到 Merchant API”
通过为智能体提供 系统说明:MerchantIntegrator 智能体
协议
并授予其对 MCP 的访问权限,您的智能体可以直接在 IDE 中将 Content API for Shopping 代码翻译为
Merchant API 代码。在这种情况下,它会将 productInputs.insert 识别为等效调用,并将商品属性从旧格式映射到 Merchant API 所需的新格式。它还可以更新所需的导入和依赖项管理文件(例如 requirements.txt、pom.xml 或 package.json)。您可以指示智能体就地进行更改,也可以指示其创建新文件夹。
场景 2:查找等效功能
您有一个使用 Content API for Shopping 的现有应用,需要对其进行更新。您可以询问特定的旧版方法,以获取有关新实现方式的详细信息和相关代码示例。
用户提示:
“Content API for Shopping 中的 accountstatuses.get 方法的 Merchant API 等效方法是什么?”
MCP 服务会提供来自官方迁移指南和参考文档的情境,让您的助理能够提供详细的答案,包括新的 API 名称 accounts.issues。
场景 3:查找代码示例
您正在实现一项新功能,需要一个可供参考的实用示例。
用户提示:
“向我展示一个使用 Merchant API 添加新配送服务的 Python 代码示例。”
MCP 服务会从 Google 官方 GitHub 代码库和开发者指南中检索相关代码示例。然后,您的助理可以呈现一个完整的、可随时改编的代码块。
场景 4:了解 API 概念
您遇到了一个新概念,或者想要了解资源的结构或整体 Merchant API 模式。
用户提示:
“如何使用 Merchant API 更新商品的库存?”
MCP 服务会返回来自商品资源文档和相关指南的情境。然后,您的助理可以解释如何使用 accounts.productInputs.insert 方法,并提供仅包含 productId 和您需要更新的库存相关字段的部分商品资源。
“如何使用 Merchant API 授权我的应用调用?”
MCP 服务会从涵盖不同授权方法的官方身份验证指南中检索情境。然后,您的助理可以解释可用的主要选项,例如在服务器到服务器互动中使用服务账号,或在代表用户执行操作时使用 OAuth 2.0 客户端 ID。
场景 5:适应 API 更改
Merchant API 引入了与 Content API for Shopping 不同的新模式(例如批量处理请求)。Content API for Shopping 使用特定的 custombatch 方法,而 Merchant API 使用内置的通用 HTTP 批量处理功能。
用户提示:
“在 Merchant API 中执行 products.custombatch 的新方法是什么?”
MCP 服务会从 Refactor code for concurrent
requests
中检索情境,解释 Merchant API 中不存在专用的 custombatch 方法。
相反,它提供了有关使用 HTTP 批量处理(Content-Type 为 multipart)的文档。然后,您的助理可以解释如何构建包含多个 API 调用的单个 HTTP 请求(发送到 https://merchantapi.googleapis.com/batch/{sub-api}/v1 端点),并提供有关如何构建多部分请求的示例。这样,原本可能令人困惑的迁移任务就变成了一个引导式流程。
场景 6:翻译报告查询
您可以要求智能体将报告查询从 Content API for Shopping 翻译为 Merchant API。
用户提示:
“将此报告查询从 Content API 迁移到 Merchant API:SELECT metrics.impressions, metrics.clicks, metrics.ctr FROM MerchantPerformanceView WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-30'”
MCP 服务会检索最新的报告参考文档、开发者指南和迁移指南。根据这些信息,它会将查询转换为新结构,并将字段更新为新名称和值。
知识库来源
MCP 服务完全基于公开的官方来源构建其知识库,以确保其提供的情境准确可靠。该服务会对官方开发者网站和代码示例代码库的全部内容进行索引,包括:
- Merchant API 开发者 网站:所有指南、参考 资料和文档。
- Merchant API Apps 脚本 服务: 来自 Apps 脚本 的 Merchant API 使用示例。
- 官方代码示例: GitHub 代码库中所有 Google 提供的 Merchant API 官方代码示例。
- 客户端库: Merchant 支持的所有官方客户端库