คุณใช้คำขอแบบกลุ่ม กับ Merchant API เพื่อส่งคำขอ HTTP หลายรายการในการเรียก API ครั้งเดียวได้
หากต้องการทำงานแบบกลุ่มด้วยไลบรารี ของไคลเอ็นต์ โปรดดูปรับโครงสร้างโค้ดสำหรับคำขอพร้อมกัน
คำขอกลุ่มคือคำขอ HTTP มาตรฐานรายการเดียวที่มีการเรียก API หลายรายการ
โดยใช้multipart/mixed
ประเภทเนื้อหา ภายในคำขอ HTTP หลัก แต่ละส่วนจะมีคำขอ HTTP ที่ซ้อนกันอยู่
คุณสามารถส่งคำขอแบบกลุ่มไปยัง batchPath
ที่ระบุสำหรับ API batchPath
สำหรับ Merchant API คือ batch/{sub-api}/v1
คุณดู
batchPath
สำหรับ API อื่นๆ ได้ในเอกสารการค้นหา ตัวอย่างเหตุผลในการจัดกลุ่มคำขอมีดังนี้
- คุณเพิ่งเริ่มใช้ API และมีข้อมูลจำนวนมากที่ต้องอัปโหลด
- ผู้ใช้ทำการเปลี่ยนแปลงข้อมูลขณะที่แอปพลิเคชันออฟไลน์ และแอปพลิเคชันของคุณต้องซิงค์ข้อมูลในเครื่องกับเซิร์ฟเวอร์
การส่งคำขอหลายรายการพร้อมกันจะช่วยให้คุณไม่ต้องรอคำขอแบบย่อยที่ช้าที่สุด ซึ่งจะช่วยปรับปรุงเวลาในการตอบสนองของเซิร์ฟเวอร์และลดเวลาในการตอบสนอง
เขียนคำขอแบบกลุ่ม
ตัวอย่างคำขอแบบกลุ่มของ Merchant API มีดังนี้ คำขอนี้รวมคำขอ GET เพื่อดึงข้อมูลสินค้าคงคลังระดับภูมิภาคสำหรับผลิตภัณฑ์ และคำขอ INSERT เพื่อ อัปเดตสินค้าคงคลังระดับภูมิภาคสำหรับผลิตภัณฑ์เดียวกัน คุณควรทำตามรูปแบบ ของตัวอย่างอย่างเคร่งครัด
- ใช้
https://merchantapi.googleapis.com/batch/{sub-api}/v1
เป็น URL ฐาน - ระบุขอบเขตเพื่อแยกคำขอที่ซ้อนกันแต่ละรายการ เช่น
-H 'Content-Type: multipart/mixed,boundary=batch_inventory' \
- แยกคำขอที่ซ้อนกันแต่ละรายการด้วยขอบเขต เช่น
--batch_inventory
- ใส่
Content-Type: application/http
ที่จุดเริ่มต้นของคำขอที่ซ้อนกันแต่ละรายการ - ใช้
Content-ID
เพื่อติดป้ายกำกับคำขอที่ซ้อนกันแต่ละรายการด้วยรหัสของคุณเอง ตัวอย่างเช่นContent-ID: <get~en~US~123456>
- เว้นบรรทัดว่างระหว่างส่วนหัว เส้นทาง และเนื้อหาของคำขอที่ซ้อนกันแต่ละรายการ หากคำขอที่ซ้อนกันไม่มีเนื้อหา ให้เว้นบรรทัดว่าง ก่อนขอบเขตถัดไป
- อย่าใส่ URL ฐานในคำขอที่ซ้อนกันแต่ละรายการ
- สิ้นสุดคำขอหลักด้วยขอบเขตสุดท้าย เช่น
--batch_inventory–
curl https://merchantapi.googleapis.com/batch/inventories/v1 \
-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/v1/accounts/123/products/online:en:US:123456/regionalInventories
--batch_inventory
Content-Type: application/http
Content-ID: <post:online:en:US:123456>
POST /inventories/v1/accounts/123/products/online:en:US:123456/regionalInventories:insert
{
"region: "123456",
"price": {
"amountMicros": "100000000",
"currencyCode": "USD"
}
}
--batch_inventory--
'
หมายเหตุเกี่ยวกับการสั่งซื้อ
- คำขออาจไม่ดำเนินการตามลำดับที่คุณระบุ
- ใช้
Content-ID
เพื่อระบุคำขอแต่ละรายการ - หากต้องการเรียกใช้การเรียกในลำดับที่กำหนด ให้ส่งการเรียกแยกกันและรอการตอบกลับคำขอแรกก่อนส่งคำขอถัดไป
อ่านการตอบกลับแบบกลุ่ม
ต่อไปนี้คือตัวอย่างการตอบกลับแบบกลุ่มของ HTTP ลำดับการตอบกลับอาจไม่ตรงกับลำดับคำขอ ใช้ Content-ID
เพื่อระบุคำขอที่ซ้อนกัน
ซึ่งการตอบกลับที่ซ้อนกันแต่ละรายการเป็นของคำขอนั้น ในการตอบกลับ API จะเพิ่มคำนำหน้า
response-
ให้กับแต่ละ Content-ID
--batch_inventory
Content-Type: application/http
Content-ID: <response-get~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~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/en~US~123456/regionalInventories/123456",
"region": "123456",
"price": {
"amountMicros": "100000000",
"currencyCode": "USD"
}
}
--batch_inventory--
'