Panduan ini memperkenalkan metode permintaan dan respons utama yang membentuk Google Docs API dan cara memperbarui dokumen secara berkelompok.
Anda bisa memanggil Google Docs API menggunakan permintaan HTTP, atau dengan menggunakan metode pemanggilan di library klien khusus bahasa. Secara umum, kedua hal tersebut 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 isi dokumen, format, dan fitur lainnya.documents.batchUpdate: Kirim daftar permintaan pengeditan untuk diterapkan secara atomik pada dokumen, dan mengembalikan daftar hasil.
Metode documents.get dan documents.batchUpdate memerlukan documentId
sebagai parameter untuk menentukan dokumen target. Metode documents.create
menampilkan instance dokumen yang dibuat, tempat Anda dapat membaca
documentId. Untuk mengetahui informasi selengkapnya tentang documentId, lihat Dokumen
ID.
Kumpulan update
documents.batchUpdate
mengambil daftar
Objek request, masing-masing
yang menentukan satu permintaan untuk dilakukan. Misalnya, format paragraf dan kemudian
menambahkan gambar sisipan. 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 tidak valid, maka seluruh pembaruan akan gagal dan tidak ada satu pun (kemungkinan dependen) akan diterapkan.
Beberapa metode documents.batchUpdate memberikan respons dengan informasi tentang
permintaan yang diterapkan. Metode ini menampilkan respons
isi yang
berisi daftar response
objek terstruktur dalam jumlah besar. Permintaan lain tidak perlu menampilkan informasi dan menampilkan kolom kosong
balas. Objek dalam daftar respons menempati urutan indeks yang sama dengan
permintaan terkait.
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 Docs API Anda dan
documents.batchUpdate
dokumentasi referensi untuk jenis permintaan dan respons.
Operasi update batch
Ada berbagai jenis permintaan update batch. Berikut adalah perincian jenis permintaan, yang dikelompokkan menjadi kategori yang berbeda.