Merchant API 概览

本页简要介绍了 Merchant API,并说明了如何使用该 API 自动执行与管理 Merchant Center 中的账号、商品和商品目录相关的各种工作流程。

您可以使用 Merchant API 覆盖更多客户,并在 Google 各平台上展示您的商品。您可以使用 Merchant API 管理大型或复杂的 Merchant Center 账号。一些典型用例包括:

  • 自动账号管理
  • 自动化产品管理
  • 自动化的产品目录管理系统
  • 自定义报告

借助 Merchant API,您可以创建和管理多个数据源,从而更好地整理有关商品、促销活动和评价的信息。借助 Merchant API,您可以采用与文件和自动 Feed 等其他商品数据上传方法相辅相成的方式来管理商品。Merchant API 还允许您并行运行多个单独的请求

Merchant API 是对 Content API for Shopping重新设计。它包含多个子 API

Merchant API 的新变化

以下是升级到 Merchant API 的一些原因:

如需了解详情,请参阅在 Merchant API Beta 版中引入的新功能

前期准备

如需运行 Merchant API 请求,您必须具备以下条件:

  • Merchant Center 账号:您将通过此账号查询、更新和上传数据。 确保您拥有在此账号中管理商品和商品目录所需的权限。

  • Google Cloud 项目:该项目用于获取对您账号的 API 访问权限。

  • 通过调用 Developer Registration 方法将您的 Merchant Center 账号与 Google Cloud 项目相关联。关联账号的用户将收到 API 通信,包括强制性服务公告、开发者调查问卷和机会。

使用 Merchant API 进行身份验证

您可以使用以下身份验证选项:

  • 您可以为应用生成 OAuth 2.0 客户端 ID 和密钥。然后,您可以使用该 ID 和密钥生成 API 调用中所需的 OAuth 2.0 凭据,以访问 Merchant Center 账号。
  • 您可以创建服务账号并下载其私钥以进行 API 调用。

账号和商品标识符

Merchant API 使用资源名称而非 ID 进行标识。商品的资源名称示例可以是 accounts/123456/products/online~en~US~sku123,其中 123456 是账号的唯一标识符,online~en~US~sku123 是商品的唯一标识符。

请求网址格式

如需对资源执行操作,请向以下格式的网址发送请求:

https://merchantapi.googleapis.com/{SUB_API}/{VERSION}/{RESOURCE_NAME}:{METHOD}

对于 list 和 get 等标准方法,系统会省略 :{METHOD} 部分。

例如,以下请求会删除区域性商品目录:

DELETE https://merchantapi.googleapis.com/inventories/v1beta/accounts/123456/products/online~en~US~sku123/regionalInventories/456

如需创建资源,您可以使用父资源的资源名称和以下网址:

POST https://merchantapi.googleapis.com/{SUB_API}/{VERSION}/{RESOURCE_NAME_OF_PARENT}/{RESOURCE}

例如,以下请求展示了如何为 accounts/123456 创建地区

POST https://merchantapi.googleapis.com/accounts/v1beta/accounts/123456/regions?regionId=WA HTTP/1.1

{
  "displayName": "Washington",
  "name": "Washington",
  "postalCodeArea": {
    "postalCodes": [
      {
        "begin": "98039",
        "end": "98118"
      }
    ],
    "regionCode": "US"
  }
}

如需详细了解特定服务,请参阅商家 API 参考文档

Merchant API 使用入门

如需快速了解 Merchant API 的运作方式并尝试上传示例商品,请参阅 Merchant API 使用入门

使用 gRPC 或 REST

Merchant API 支持 gRPCREST。以下是调用 Merchant API 的两种方式:

gRPC(推荐) REST
  1. 以协议缓冲区的形式创建请求正文。
  2. 使用 HTTP/2 将请求正文发送到服务器。
  3. 将响应反序列化为协议缓冲区。
  4. 解读结果。
  1. 以 JSON 对象的形式创建请求正文。
  2. 使用 HTTP 1.1 将其发送到服务器。
  3. 将响应反序列化为 JSON 对象。
  4. 解析结果。

使用客户端库和代码示例

每个子 API 都有客户端库,可帮助您快速入门。代码示例可帮助您开始使用 Java、PHP 和 Python 编写代码。如需了解详情,请参阅 Merchant API 的示例

获取帮助

如需了解如何获取支持,请参阅获取 Merchant API 方面的帮助

提供反馈

在 Beta 版阶段,我们可以收集并解决您的反馈,然后再发布正式版。如需提供反馈,请提交以下任一内容:

  • API 功能:提交反馈表单
  • 文档:使用页面上的拇指评分和发送反馈按钮。
  • 示例和库:在 GitHub 代码示例代码库中创建问题

在完成每项任务后,如需提供一般性反馈,请使用反馈表单

后续步骤

  • 如需了解向后兼容性,请参阅 Content API for Shopping 兼容性

  • 如需详细了解 Merchant API 的主要功能,请参阅左侧导航菜单中的指南。

  • 如需了解可用资源和服务,请参阅参考文档