您可以将批量请求与 Merchant API 搭配使用,在单个 API 调用中发送多个 HTTP 请求。
如果您更希望使用客户端库执行批处理,请参阅重构并发请求的代码。
批量请求是一个包含多个 API 调用的标准 HTTP 请求,使用 multipart/mixed
内容类型。在主 HTTP 请求中,每个部分都包含一个嵌套的 HTTP 请求。
您可以将批量请求发送到 API 的指定 batchPath
。Merchant API Beta 版的 batchPath
为 batch/{sub-api}/v1beta
。您可以在其他 API 的发现文档中找到其 batchPath
。批量处理请求的原因示例包括:
- 您刚开始使用该 API,并且需要上传大量数据。
- 用户在应用离线时对数据进行了更改,因此您的应用需要将本地数据与服务器同步。
并行发送多个请求可避免您等待最慢的子请求,从而缩短服务器响应时间并降低延迟时间。
编写批量请求
以下是 Merchant API 批量请求示例。此请求结合了用于检索商品的地区性商品目录的 get 请求,以及用于更新同一商品的地区性商品目录的 insert 请求。您应严格遵循示例的格式:
- 使用
https://merchantapi.googleapis.com/batch/{sub-api}/v1beta
作为基本网址。 - 指定边界以分隔每个嵌套请求,例如:
-H 'Content-Type: multipart/mixed,boundary=batch_inventory' \
- 使用边界将每个嵌套请求分隔开来,例如
--batch_inventory
。 - 在每个嵌套请求的开头添加
Content-Type: application/http
。 - 使用
Content-ID
为每个嵌套请求添加自己的 ID 标签。例如:Content-ID: <get:online:en:US:123456>
。 - 在每个嵌套请求的标头、路径和正文之间添加一个空行。如果嵌套请求没有正文,请在下一个边界之前留出一个空行。
- 请勿在每个嵌套请求中添加基本网址。
- 使用最终边界(例如
--batch_inventory–
)结束主请求。
curl https://merchantapi.googleapis.com/batch/inventories/v1beta \
-H 'Authorization: Bearer <TOKEN>' \
-H 'Content-Type: multipart/mixed,boundary=batch_inventory' \
--data '
--batch_inventory
Content-Type: application/http
Content-ID: <get:online:en:US:123456>
GET /inventories/v1beta/accounts/123/products/online:en:US:123456/regionalInventories
--batch_inventory
Content-Type: application/http
Content-ID: <post:online:en:US:123456>
POST /inventories/v1beta/accounts/123/products/online:en:US:123456/regionalInventories:insert
{
"region: "123456",
"price": {
"amountMicros": "100000000",
"currencyCode": "USD"
}
}
--batch_inventory--
'
关于订购的注意事项
- 请求可能不会按您指定的顺序执行。
- 使用
Content-ID
标识各个请求。 - 如果您需要按指定顺序执行调用,请单独发送这些调用,并等待第一个请求的响应,然后再发送下一个请求。
读取批量响应
以下是 HTTP 批量响应示例。响应的顺序可能与请求的顺序不一致。使用 Content-ID
来识别每个嵌套响应所属的嵌套请求。在响应中,API 会向每个 Content-ID
添加 response-
前缀。
--batch_inventory
Content-Type: application/http
Content-ID: <response-get:online:en:US:123456>
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Vary: Origin
Vary: X-Origin
Vary: Referer
{}
--batch_inventory
Content-Type: application/http
Content-ID: <response-post:online:en:US:123456>
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Vary: Origin
Vary: X-Origin
Vary: Referer
{
"name": "accounts/123/products/online:en:US:123456/regionalInventories/123456",
"region": "123456",
"price": {
"amountMicros": "100000000",
"currencyCode": "USD"
}
}
--batch_inventory--
'