Anda dapat menggunakan permintaan batch dengan Merchant API untuk mengirim beberapa permintaan HTTP dalam satu panggilan API.
Jika Anda lebih suka melakukan batching dengan klien library, lihat Memfaktorkan ulang kode untuk serentak permintaan.
Permintaan batch adalah satu permintaan HTTP standar yang berisi beberapa panggilan API, menggunakan jenis konten multipart/mixed. Dalam permintaan HTTP utama, setiap bagian berisi permintaan HTTP bertingkat.
Anda dapat mengirim permintaan batch ke batchPath yang ditentukan untuk API.
batchPath untuk Merchant API adalah batch/{sub-api}/v1. Anda
dapat menemukan batchPath untuk API lain dalam dokumen penemuan.
Contoh alasan untuk melakukan batching permintaan Anda mencakup:
- Anda baru mulai menggunakan API dan memiliki banyak data untuk diupload.
- Pengguna melakukan perubahan pada data saat aplikasi Anda offline, dan aplikasi Anda perlu menyinkronkan data lokal dengan server.
Mengirim beberapa permintaan secara paralel mencegah Anda menunggu sub-permintaan yang paling lambat, yang meningkatkan waktu respons server dan mengurangi latensi.
Menulis permintaan batch
Berikut adalah contoh permintaan batch Merchant API. Permintaan ini menggabungkan permintaan get untuk mengambil inventaris regional untuk suatu produk, dan permintaan insert untuk memperbarui inventaris regional untuk produk yang sama. Anda harus mengikuti format contoh dengan tepat:
- Gunakan
https://merchantapi.googleapis.com/batch/{sub-api}/v1sebagai URL dasar. - Tentukan batas untuk memisahkan setiap permintaan bertingkat, misalnya:
-H 'Content-Type: multipart/mixed,boundary=batch_inventory' \ - Pisahkan setiap permintaan bertingkat dengan batas, misalnya
--batch_inventory. - Sertakan
Content-Type: application/httpdi awal setiap permintaan bertingkat. - Gunakan
Content-IDuntuk memberi label pada setiap permintaan bertingkat dengan ID Anda sendiri. Contoh:Content-ID: <get~en~US~123456>. - Sertakan baris kosong antara header, jalur, dan isi setiap permintaan bertingkat. Jika permintaan bertingkat tidak memiliki isi, kosongkan baris sebelum batas berikutnya.
- Jangan sertakan URL dasar di setiap permintaan bertingkat.
- Akhiri permintaan utama dengan batas akhir, misalnya
--batch_inventory–.
curl https://merchantapi.googleapis.com/batch/inventories/v1 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: multipart/mixed,boundary=batch_inventory' \
--data '
--batch_inventory
Content-Type: application/http
Content-ID: <get~en~US~123456>
GET /inventories/v1/accounts/123/products/en~US~123456/regionalInventories
--batch_inventory
Content-Type: application/http
Content-ID: <post~en~US~123456>
POST /inventories/v1/accounts/123/products/en~US~123456/regionalInventories:insert
{
"region": "123456",
"price": {
"amountMicros": "100000000",
"currencyCode": "USD"
}
}
--batch_inventory--'
Catatan tentang pengurutan
- Permintaan mungkin tidak dieksekusi sesuai urutan yang Anda tentukan.
- Gunakan
Content-IDuntuk mengidentifikasi permintaan individual. - Jika Anda perlu menjalankan panggilan dalam urutan tertentu, kirim panggilan secara terpisah dan tunggu respons terhadap permintaan pertama sebelum mengirim permintaan berikutnya.
Membaca respons batch
Berikut adalah contoh respons batch HTTP. Urutan respons mungkin tidak sesuai dengan urutan permintaan. Gunakan Content-ID untuk mengidentifikasi permintaan bertingkat yang menjadi tujuan setiap respons bertingkat. Dalam respons, API menambahkan awalan response- ke setiap 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--
'