您可以搭配使用批次要求與 Merchant API,在單一 API 呼叫中傳送多個要求。
批次要求是單一標準 HTTP 要求,內含多個使用 multipart/mixed
內容類型的 API 呼叫。在主要 HTTP 要求中,每個部分都包含巢狀 HTTP 要求。
您可以將批次要求傳送至 API 的指定 batchPath
。Merchant API Beta 版的 batchPath
為 batch/{sub-api}/v1beta
。您可以在探索文件中找到其他 API 的 batchPath
。
以下舉例說明在某些情況下,您可能會想要批次處理要求:
- 您剛開始使用 API,有很多資料需要上傳。
- 使用者在應用程式離線時變更了資料,而您的應用程式需要同步處理本機資料與伺服器。
如果您對 HTTP 批次處理有任何疑問,或想要求使用我們的用戶端程式庫傳送批次要求,請提交意見回饋。
編寫批次要求
以下是 Merchant API 批次要求的範例。這項要求會結合擷取要求來擷取產品的區域商品目錄資料,以及用於更新相同產品店面商品目錄資料的插入要求。
請確實遵循範例格式:
- 請使用
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--
'
如果您需要按照特定順序執行呼叫,請分別傳送這些呼叫,並等待第一個要求的回應後再傳送下一個要求。
讀取批次回應
以下是 HTTP 批次回應的範例。回應的順序可能與要求的順序不同。使用 Content-ID
識別每個巢狀回應所屬的巢狀要求。在回應中,每個 Content-ID
的前置字串都是 response-
。
--batch_YCE-jYH0pmDrBIHeHhltcpXIMpk0VTzQ
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_YCE-jYH0pmDrBIHeHhltcpXIMpk0VTzQ
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_YCE-jYH0pmDrBIHeHhltcpXIMpk0VTzQ--
'