Permintaan batch

Dokumen ini menunjukkan cara mengelompokkan panggilan API untuk mengurangi jumlah koneksi yang harus dibuat klien Anda. Pengelompokan dapat meningkatkan efisiensi aplikasi dengan mengurangi perjalanan bolak-balik jaringan dan meningkatkan throughput.

Ringkasan

Setiap koneksi yang dibuat oleh klien Anda menghasilkan sejumlah {i>overhead<i} tertentu. Google Docs API mendukung pengelompokan agar klien Anda dapat menempatkan beberapa objek permintaan, masing-masing menentukan satu jenis permintaan yang akan dilakukan, dalam satu permintaan batch. Permintaan batch dapat meningkatkan performa dengan menggabungkan beberapa subpermintaan ke dalam satu panggilan ke server, sehingga mengambil satu respons kembali.

Kami mendorong pengguna untuk selalu mengelompokkan beberapa permintaan sekaligus. Berikut adalah beberapa contoh situasi saat Anda dapat menggunakan pengelompokan:

  • Anda baru saja mulai menggunakan API dan memiliki banyak data untuk diupload.
  • Anda perlu mengupdate metadata atau properti, seperti pemformatan, pada beberapa objek.
  • Anda perlu menghapus banyak objek.

Pertimbangan batas, otorisasi & dependensi

Berikut daftar item lain yang perlu dipertimbangkan saat menggunakan update batch:

  • Setiap permintaan batch, termasuk semua subpermintaan, dihitung sebagai satu permintaan API terhadap batas penggunaan Anda.
  • Permintaan batch diautentikasi sekali. Autentikasi tunggal ini berlaku untuk semua objek update batch dalam permintaan.
  • Server memproses subpermintaan dalam urutan yang sama dengan yang muncul dalam permintaan batch. Subpermintaan selanjutnya dapat bergantung pada tindakan yang diambil selama subpermintaan sebelumnya. Misalnya, dalam permintaan batch yang sama, pengguna dapat menyisipkan teks ke dalam dokumen yang sudah ada lalu menata gayanya.

Detail batch

Permintaan batch terdiri dari satu panggilan metode batchUpdate dengan beberapa subpermintaan untuk, misalnya, menambahkan dan memformat dokumen.

Setiap permintaan divalidasi sebelum diterapkan. Semua subpermintaan dalam batch update diterapkan secara atomik. Artinya, jika ada permintaan yang tidak valid, seluruh update akan gagal dan tidak ada perubahan (yang berpotensi bergantung) yang diterapkan.

Beberapa permintaan memberikan respons dengan informasi tentang permintaan yang diterapkan. Misalnya, semua permintaan batch update untuk menambahkan objek akan menampilkan respons sehingga Anda dapat mengakses metadata objek yang baru ditambahkan, seperti ID atau judul.

Dengan pendekatan ini, Anda dapat membuat seluruh dokumen Google menggunakan satu permintaan update batch API dengan beberapa subpermintaan.

Format permintaan batch

Permintaan adalah satu permintaan JSON yang berisi beberapa subpermintaan bertingkat dengan satu properti yang diperlukan: requests. Permintaan dibuat dalam array permintaan individual. Setiap permintaan menggunakan JSON untuk mewakili objek permintaan dan untuk menampung propertinya.

Format respons batch

Format response untuk permintaan batch mirip dengan format permintaan. Respons server berisi balasan lengkap untuk satu objek respons.

Properti objek JSON utama diberi nama replies. Respons ditampilkan dalam array, dengan masing-masing respons terhadap salah satu permintaan menempati urutan indeks yang sama dengan permintaan yang terkait. Beberapa permintaan tidak memiliki respons dan respons pada indeks array tersebut kosong.

Contoh

Contoh kode berikut menunjukkan penggunaan pengelompokan dengan Docs API.

Permintaan

Contoh permintaan batch ini menunjukkan cara:

  • Sisipkan teks "Hello World" ke awal dokumen yang sudah ada, dengan indeks location 1, menggunakan InsertTextRequest.

  • Perbarui kata "Halo" menggunakan UpdateTextStyleRequest. startIndex dan endIndex menentukan range teks berformat dalam segmen.

  • Dengan menggunakan textStyle, tetapkan gaya font menjadi tebal dan warna menjadi biru hanya untuk kata "Hello".

  • Dengan menggunakan kolom WriteControl, Anda dapat mengontrol cara permintaan tulis dijalankan. Untuk mengetahui informasi selengkapnya, lihat Menetapkan konsistensi status dengan WriteControl.

{
   "requests":[
      {
         "insertText":{
            "location":{
               "index":1
            },
            "text":"Hello World"
         }
      },
      {
         "updateTextStyle":{
            "range":{
               "startIndex":1,
               "endIndex":6
            },
            "textStyle":{
               "bold":true,
               "foregroundColor":{
                  "color":{
                     "rgbColor":{
                        "blue":1
                     }
                  }
               }
            },
            "fields":"bold,foreground_color"
         }
      }
   ],
   "writeControl": {
      "requiredRevisionId": "REQUIRED_REVISION_ID"
  }
}

Ganti REQUIRED_REVISION_ID dengan ID revisi dokumen tempat permintaan tulis diterapkan.

Respons

Contoh respons batch ini menampilkan informasi tentang cara setiap subpermintaan dalam permintaan batch diterapkan. InsertTextRequest atau UpdateTextStyleRequest tidak berisi respons, sehingga nilai indeks array pada [0] dan [1] terdiri dari tanda kurung kurawal kosong. Permintaan batch menampilkan objek WriteControl, yang menunjukkan cara permintaan dieksekusi.

{
   "replies":[
      {},
      {}
   ],
   "writeControl":{
      "requiredRevisionId":`REQUIRED_REVISION_ID`
   },
   "documentId":`DOCUMENT_ID`
}