使用 API Integration and Code Assist Toolkit,加快迁移到 Merchant API,并使用 AI 赋能的开发者工具构建新的集成。
概览
从 Content API for Shopping 迁移到 Merchant API 或构建新的集成时,您需要了解新的服务结构、资源名称和方法。AI 赋能的开发者工具特别适合协助完成以下操作:
- 代码翻译和迁移:帮助您了解旧版 Content API for Shopping 代码并将其转换为新的 Merchant API 格式。这包括将商品属性映射到新结构,以及更新依赖项管理文件。
- API 文档专业知识:根据 Google 官方 API 文档中的权威内容,提供有关 Merchant API 资源、方法、字段、配额和最佳实践的清晰说明。
- 代码生成:为各种 Merchant API 任务生成代码段,支持 Python、Java、PHP 等多种语言。
- 问题排查:协助诊断和修复常见的 API 错误。
请选择最适合您的开发环境和特定用例的选项。使用 API 集成和 Code Assist 工具包,根据您的首选工作流定制设置:
- Merchant API 开发者文档 MCP 服务器,用于直接检索上下文
- Merchant API Agent Skills 提供工作流驱动型指导
下图展示了在最常用的集成开发环境 (IDE)(例如 Antigravity、Visual Studio Code、Cursor 或 Copilot)中进行 AI 辅助代码迁移的设置选项。您可以设置 Gemini、Claude、ChatGPT、Grok 等编码辅助,并为其提供 Merchant API 开发者文档 MCP 服务器或 Merchant API 智能体 skill,以便在提高集成速度的同时,让其更基于事实。
Merchant API 开发者文档 MCP 服务器
通过您选择的编码辅助获取有关 Merchant API 的情境智能。现在,您可以在 IDE 中使用 Model Context Protocol (MCP) 服务访问开发者文档。此服务会从 Google API 官方文档中为您的编码助理提供关键信息。如需详细了解该协议本身,请参阅 Model Context Protocol 标准。
运作方式
当您向支持 MCP 的 IDE 编码辅助询问有关 Merchant API 的问题时,该服务会使用专门的检索增强生成 (RAG) 后端,从官方资源中检索最相关的文本和代码段,并将其作为上下文返回给编码辅助。RAG 系统通过将 LLM 连接到最新的外部知识来源,来提高 LLM 的回答质量。这样,您的助理就能提供准确、最新的回答,而您无需离开开发环境。
工作流示例:
- 您在与 MCP 兼容的编码辅助或智能体中提出问题(例如,自然语言问题、代码示例请求或代码翻译)。
- 您的编码辅助会向 MCP 端点发送上下文请求。
- MCP 服务会搜索其已编入索引的官方 Merchant API 文档、指南和代码示例集合。
- 该服务会返回权威代码段,作为编码助理的上下文。
- 您的编码辅助会利用此上下文生成基于事实的回答或代码翻译任务。
使用入门
如需集成和使用 MCP,请按以下步骤操作:
1. 使用兼容的工具
打开支持 Model Context Protocol 且具有可流式传输的 HTTP 传输的 IDE 或编码辅助工具。
2. 配置端点
如需将 IDE 或编码辅助工具连接到 MCP,请使用提供的远程端点详细信息。根据工具的配置,您可能需要输入直接服务网址或 MCP 定义:
配置设置:
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 直接转换代码,请为其提供系统指令:Merchant Integrator Agent Protocol。这些指令会指导智能体如何正确利用 MCP 进行代码翻译。根据您使用的工具,您可以在系统指令配置中提供这些指令,也可以将其作为代理的额外上下文文件提供。
使用场景示例
在以下常见应用场景中,MCP 可以加快您的工作流:
场景 1:迁移 products.insert 代码
您可以让智能体直接将 Content API for Shopping products.insert 集成代码迁移到 Merchant API。
用户提示:
“将
products.insert代码迁移到 Merchant API”
通过为智能体提供系统指令和 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:查找代码示例
您正在实现一项新功能,需要一个实际示例作为参考。
用户提示:
“请向我展示一个 Python 代码示例,说明如何使用 Merchant API 添加新的配送服务。”
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 批处理功能。
用户提示:
"What is the new way to do a products.custombatch in Merchant API?"
MCP 服务从重构代码以处理并发请求中检索上下文,其中说明了 Merchant API 中不存在专用的 custombatch 方法。而是提供有关将 HTTP 批处理与 multipart 的 Content-Type 结合使用的文档。然后,您的助理可以说明如何构建包含多个 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 服务会检索最新的报告参考文档、开发者指南和迁移指南。根据这些信息,它会将查询转换为新结构,并将字段更新为新名称和值。
Merchant API Agent Skills
Agent Skills 规范是各种 AI 开发者工具采用的开放标准。使用 Agent Skills 提升开发者体验,并优化从 Content API for Shopping 迁移和构建新集成的过程。Merchant API Agent Skills 封装了特定领域的知识和工具,可增强 AI 智能体的功能,并针对文档查询、代码生成和问题排查提供按需专家协助。
Merchant API Agent Skills 与各种 AI 赋能的命令行工具和 IDE(例如 Antigravity 和 Claude Code)兼容。
运作方式
Merchant API 智能体技能提供基于开放式智能体技能标准构建的专业知识包。我们的智能体技能 mapi-developer-assistant 充当 AI 开发者工具与底层 Merchant API Dev Doc MCP 服务器之间的智能层。它嵌入了领域专业知识和程序指导,具有以下属性:
- 零配置:自动管理 MCP 服务器连接,无需手动设置端点。
- 专家工作流:将用户提示优化为更精准的查询,从而高效获取最相关的信息。
- 上下文管理和 token 效率:使用“渐进式披露”按需加载信息,并保留 AI 的上下文窗口。
- 增强型输出格式设置:提供有关如何设置输出格式和结构的说明,以生成可操作、可读且一致的回答。
工作流示例:
- 您在 AI 开发者工具中询问有关 Merchant API 的问题。
- Merchant API Agent Skill 会分析您的意图,制定精确的查询,并将程序化知识应用于请求。
- 代理技能向位于
merchantapi.googleapis.com/devdocs/mcp/的 Merchant API 开发者文档 MCP 服务器发送上下文请求。 - MCP 服务会搜索其已编入索引的官方 Merchant API 文档、指南和代码示例集合。
- 您的 AI 智能体利用这些信息提供综合且可操作的回答。
使用入门
Merchant API Agent Skills README 提供了有关以下方面的分步指南:
- Antigravity 命令行工具等工具的前提条件。
- 在所选工具中启用智能体技能支持。
- 按照 README 的指导,从 GitHub 代码库安装
mapi-developer-assistant技能。 - 验证安装。
- 基本技能管理命令。
如需了解各种 AI 工具(包括 Antigravity 命令行工具、Claude Code 等)的详细安装和设置说明,请按照 README 文件中的指南操作。
示例提示
在 AI 开发者工具中安装并启用 mapi-developer-assistant skill 后,当您提出与 Merchant API 相关的问题时,该 skill 通常会自动激活。
“如何在 Python 中使用 Merchant API 插入商品?”
“Content API
accountstatuses.get方法对应的 Merchant API 是什么?”
“请展示一个使用 Merchant API 处理身份验证的 Java 示例。”
“我在调用
productInputs.insert时收到‘400 无效请求’错误,并显示验证错误。如何解决此问题?”
“Merchant API 中的
ProductInput和Product有何区别?”
知识库来源
MCP 服务仅从公开和官方来源构建其知识库,以确保其提供的上下文准确可靠。该服务会为官方开发者网站和代码示例代码库的全部内容编制索引,包括:
- Merchant API 开发者网站:所有指南、参考资料和文档。
- Merchant API Apps 脚本服务:通过 Apps 脚本使用 Merchant API 的示例。
- 官方代码示例:GitHub 代码库中由 Google 提供的所有 Merchant API 官方代码示例。
- 客户端库:Merchant API 支持的所有官方客户端库。