Panduan ini memperkenalkan metode permintaan dan respons utama yang membentuk Google Docs API dan cara memperbarui dokumen dalam batch.
Anda dapat memanggil Google Docs API menggunakan permintaan HTTP, atau dengan menggunakan pemanggilan metode di library klien khusus bahasa. Secara umum, ini setara.
Google Docs API menampilkan respons HTTP, yang umumnya menyertakan hasil pemanggilan permintaan. Saat menggunakan library klien untuk membuat permintaan, respons akan ditampilkan dengan cara spesifik per bahasa.
Metode permintaan
Docs API mendukung metode berikut:
documents.create: Buat dokumen Google Dokumen kosong.documents.get: Menampilkan instance lengkap dari dokumen yang ditentukan. Anda dapat mengurai JSON yang ditampilkan untuk mengekstrak konten dokumen, pemformatan, dan fitur lainnya.documents.batchUpdate: Kirim daftar permintaan pengeditan untuk diterapkan secara atomik ke dokumen, dan tampilkan daftar hasilnya.
Metode documents.get dan documents.batchUpdate memerlukan documentId sebagai parameter untuk menentukan dokumen target. Metode documents.create menampilkan instance dari dokumen yang telah dibuat, yang memungkinkan Anda membaca documentId. Untuk informasi selengkapnya tentang documentId, lihat ID Dokumen.
Update massal
Metode documents.batchUpdate
mengambil daftar objek
request, masing-masing
menentukan satu permintaan yang akan dilakukan. Misalnya, format paragraf, lalu
tambahkan gambar inline. Setiap permintaan divalidasi sebelum diterapkan dan
permintaan diproses sesuai dengan urutan yang muncul dalam permintaan batch.
Semua permintaan 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 metode documents.batchUpdate memberikan respons dengan informasi tentang
permintaan yang diterapkan. Metode ini menampilkan isi
respons yang
berisi daftar objek
response. Permintaan lain tidak perlu menampilkan informasi dan menampilkan balasan
kosong. Objek dalam daftar respons menempati urutan indeks yang sama dengan
permintaan yang sesuai.
Pola populer untuk membuat permintaan batch terlihat seperti ini:
requests = []
requests.append(first request)
requests.append(second request)
...
body = ... & requests & ...
...batchUpdate(body)
Lihat praktik terbaik permintaan batch untuk mengetahui detail selengkapnya tentang
cara mengelompokkan panggilan API Dokumen dan
dokumentasi referensi documents.batchUpdate
untuk jenis permintaan dan respons.
Operasi update batch
Ada berbagai jenis permintaan batch update. Berikut adalah perincian jenis permintaan, yang dikelompokkan ke dalam berbagai kategori.