API 集成和 Code Assist Toolkit

使用 API 集成和代码辅助工具包加快迁移到 Merchant API 的速度,并使用 AI 赋能的开发工具构建新的集成。

概览

从 Content API for Shopping 迁移到 Merchant API 或构建新的集成时,您需要了解新的服务结构、资源名称和方法。AI 赋能的开发工具特别适合协助执行以下操作:

  • 代码翻译和迁移:帮助您了解旧版 Content API for Shopping 代码并将其转换为新的 Merchant API 格式。这包括将商品属性映射到新结构,以及更新依赖项管理文件。
  • API 文档专业知识:根据 Google 官方 API 文档中的权威上下文,清晰说明 Merchant API 资源、方法、字段、配额和最佳实践。
  • 代码生成:以 Python、Java、PHP 等语言为各种 Merchant API 任务生成代码段。
  • 问题排查:协助诊断和修复常见的 API 错误。

选择最适合您的开发环境和特定使用场景的选项。使用 API 集成和代码辅助工具包,根据您偏好的工作流定制设置:

下图展示了在最常用的集成开发环境 (IDE)(例如 Antigravity、Visual Studio Code、Cursor 或 Copilot)中进行 AI 辅助代码迁移的设置选项。您可以设置 Gemini、Claude、ChatGPT、Grok 等编码助理,并使用 Merchant API 开发者文档 MCP 服务器或 Merchant API 智能体技能为其赋能,使其更具基础性,同时提高集成速度。

(Merchant API)AI 集成 Code Assist 图

Merchant API 开发者文档 MCP 服务器

从您选择的编码助理获取有关 Merchant API 的上下文智能。现在,您可以在 IDE 中使用 Model Context Protocol (MCP) 服务访问开发者文档。此服务会向您的编码助理提供 Google 官方 API 文档中的关键信息。如需详细了解协议本身,请参阅 Model Context Protocol 标准

运作方式

当您向启用 MCP 的 IDE 编码助理询问有关 Merchant API 的问题时,该服务会从官方资源中检索最相关的文本和代码段,并使用专门的检索增强生成 (RAG) 后端将其作为上下文返回给您的编码助理。RAG 系统是一种通过将 LLM 连接到外部最新知识来源来提高 LLM 回答质量的系统。这样,您的助理就可以提供准确的最新答案,而您无需离开开发环境。

工作流示例

  1. 您在与 MCP 兼容的编码助理或智能体中提出问题(例如,自然语言问题、代码示例请求或代码翻译)。
  2. 您的编码助理向 MCP 端点发送上下文请求。
  3. MCP 服务搜索其已编入索引的 Merchant API 官方文档、指南和代码示例集合。
  4. 该服务会将权威代码段作为上下文返回给您的编码助理。
  5. 您的编码助理会利用此上下文生成有依据的答案或代码翻译任务。

使用入门

如需集成和使用 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.txtpom.xmlpackage.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-Typemultipart)的文档。然后,您的助理可以说明如何构建包含多个 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 智能体技能

智能体技能规范是 AI 开发工具采用的开放 标准。使用智能体技能可以提升开发者体验,并优化从 Content API for Shopping 迁移和构建新集成的过程。Merchant API 智能体技能软件包包含特定于网域的知识和工具,可增强 AI 智能体的功能,并为文档查询、代码生成和问题排查提供按需专家帮助。

Merchant API 智能体技能与各种 AI 赋能的命令行工具和 IDE(例如 Gemini 和 Claude Code)兼容。

运作方式

Merchant API 智能体技能提供基于开放智能体技能标准构建的专业知识软件包。我们的智能体技能 mapi-developer-assistant 充当 AI 开发工具与底层 Merchant API Dev Doc MCP 服务器之间的智能层。它嵌入了网域专业知识和程序指导,具有以下属性:

  • 零配置:自动管理 MCP 服务器连接, 无需手动设置端点。
  • 专家工作流:将用户提示优化为查询,以有效地提取 最相关的信息。
  • 上下文管理和令牌效率 :使用“渐进式披露”按需加载信息,并保留 AI 的上下文窗口。
  • 增强的输出格式设置:提供有关格式化和构建 输出的说明,以获得可操作、可读且一致的回答。

工作流示例

  1. 您在 AI 开发工具中询问有关 Merchant API 的问题。
  2. Merchant API 智能体技能会分析您的意图,制定精确的查询,并将程序知识应用于请求。
  3. 智能体技能会向位于 merchantapi.googleapis.com/devdocs/mcp/ 的 Merchant API Dev Doc MCP 服务器发送上下文请求。
  4. MCP 服务搜索其已编入索引的 Merchant API 官方文档、指南和代码示例集合。
  5. 您的 AI 智能体会利用这些信息提供综合且可操作的回答。

使用入门

Merchant API 智能体技能自述文件 提供了有关以下内容的逐步指导:

  • Gemini 命令行工具等工具的前提条件。
  • 在您选择的工具中启用智能体技能支持。
  • 按照自述文件的说明,从 GitHub 代码库安装 mapi-developer-assistant 技能。
  • 验证安装。
  • 基本技能管理命令。

如需详细了解各种 AI 工具(包括 Gemini 命令行工具、Claude Code 等)的安装和设置说明,请按照自述文件中的指导操作。

示例提示

在 AI 开发工具中安装并启用后,当您询问与 Merchant API 相关的问题时,mapi-developer-assistant 技能通常会自动激活。

“如何在 Python 中使用 Merchant API 插入商品?”

“Content API accountstatuses.get 方法的 Merchant API 等效方法是什么?”

“向我展示一个使用 Merchant API 处理身份验证的 Java 示例。”

“调用 productInputs.insert时,我收到了‘400 无效请求’,并显示验证错误。如何解决此问题?”

“Merchant API 中的 ProductInputProduct 有何区别?”

知识库来源

MCP 服务完全基于公开的官方来源构建其知识库,以确保其提供的上下文准确可靠。该服务会对官方开发者网站和代码示例代码库的全部内容进行索引,包括: