一次傳送多個要求

您可以使用 Merchant API 的批次要求,在單一 API 呼叫中傳送多個 HTTP 要求。

如果您偏好使用用戶端程式庫執行批次處理作業,請參閱「為並行要求重構程式碼」。

批次要求是單一標準 HTTP 要求,內含多個使用 multipart/mixed 內容類型的 API 呼叫。在主要 HTTP 要求中,每個部分都含有一個巢狀的 HTTP 要求。

您可以將批次要求傳送至 API 的指定 batchPath。Merchant API Beta 版的 batchPathbatch/{sub-api}/v1beta。您可以在其他 API 的探索文件中找到 batchPath。以下列舉一些使用批次處理要求的原因:

  • 您剛開始使用 API,而且有大量資料要上傳。
  • 使用者在應用程式離線時變更資料,因此應用程式需要將本機資料與伺服器同步。

編寫批次要求

以下是 Merchant API 批次要求的範例。這項要求結合了取得要求,用於擷取產品的區域商品目錄,以及插入要求,用於更新同一個產品的區域商品目錄。請務必完全遵循範例格式:

  1. 使用 https://merchantapi.googleapis.com/batch/{sub-api}/v1beta 做為基礎網址。
  2. 指定邊界,以便區隔每個巢狀要求,例如:-H 'Content-Type: multipart/mixed,boundary=batch_inventory' \
  3. 請使用邊界 (例如 --batch_inventory) 分隔每個巢狀要求。
  4. 在每個巢狀要求的開頭加入 Content-Type: application/http
  5. 使用 Content-ID 為每個巢狀要求加上專屬 ID 標籤。例如:Content-ID: <get:online:en:US:123456>
  6. 請在每個巢狀要求的標頭、路徑和主體之間加入空白行。如果巢狀要求沒有主體,請在下一個邊界前留空白行。
  7. 請勿在各個巢狀要求中加入基準網址。
  8. 使用最終邊界結束主要要求,例如 --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--
'