您可以参考本指南将 Merchant API 与现有的 Content API for Shopping 实现集成。
开始使用
如需详细了解 Merchant API 及其子 API,请参阅 Merchant API 设计。
如需开始使用 Merchant API,请将您的请求网址更改为以下格式:
https://merchantapi.googleapis.com/{sub-API}/{version}/{resource name}/{service}:{method}…
如需了解详情,请参阅快速入门指南和 Merchant API 参考文档。
gRPC 支持
Merchant API 支持 gRPC 和 REST。您可以同时使用适用于 Merchant API 的 gRPC 和适用于 Content API for Shopping 的 REST。
Merchant API 客户端库需要 gRPC。
如需了解详情,请参阅使用 gRPC。
兼容性
本指南介绍了适用于整个 Merchant API 的一般更改。如需了解特定功能的变更,请参阅以下指南:
Merchant API 旨在与现有 Content API for Shopping v2.1 功能配合使用。
例如,您可以将 Merchant Inventories API 与现有的 Content API for Shopping 2.1 商品目录和 products
实现搭配使用。您可以使用 Content API for Shopping 上传新的本地商品(在本地商店中销售),然后使用 Merchant Inventories API LocalInventory
资源管理该商品的店内信息。
批量请求
Merchant API 不支持 Content API for Shopping 中提供的 customBatch
方法。请改为参阅发送批量请求。如果您使用 customBatch
,并且需要为 Merchant API 使用此功能,请在反馈中告知我们原因。
标识符
为了符合 Google 的 API 改进原则,我们对 Merchant API 资源的标识符进行了一些更改。
名称替换 ID
所有 Merchant API 资源都使用 name
字段作为其唯一标识符。
以下示例说明了如何在调用中使用 name
字段:
POST https://merchantapi.googleapis.com/inventories/v1beta/{parent}/regionalInventories:insert
这个新的 name
字段会作为 Merchant API 中所有读写调用的资源标识符返回。
name
字段中返回的值使用新的 ID 格式。
例如,实现 getName()
方法以从资源中检索 name
,并将输出存储为变量,而不是自行根据商家 ID 和资源 ID 构建 name
。
新的 ID 格式
在 Merchant API 中,资源 ID 采用以下格式:channel~language~feedLabel~offerId
Content API 资源在 ID 中的每个值之间使用了 :
(而非 ~
):channel:language:feedLabel:offerId
所有 Merchant API 调用都会返回新格式,并在 ID 值之间包含 ~
。我们建议存储响应中的新格式,并在将来的调用中使用。
子资源的父字段
在 Merchant API 中,所有子资源都具有 parent
字段。您可以使用 parent
字段指定要插入子资源的资源的 name
,而不是传递整个父资源。您还可以将 parent
字段与 list
方法结合使用,以列出该 parent
的子资源。
例如,如需列出给定商品的本地商品目录,请在 list
方法的 parent
字段中指定商品的 name
。在本例中,给定的 product
是返回的 LocalInventory
资源的 parent
。
类型
以下是在 Merchant API 子 API 之间共享的一些常见类型。
价格
以下是 Merchant Common 软件包中 Price
的变更:
Content API | 商家 API | |
---|---|---|
金额字段 | value:string |
amountMicros:int64 |
币种字段 | currency:string
|
currencyCode:string |
Price
金额现在以微单位记录,100 万微单位相当于您货币的标准单位。
在 Content API for Shopping 中,Price
是一个字符串形式的十进制数。
金额字段名称已从“value
”更改为“amountMicros
”
货币字段名称已从“currency
”更改为“currencyCode
”。格式仍为 ISO 4217。