Panduan ini memperkenalkan metode permintaan dan respons utama yang membentuk Google Docs API dan cara Anda memperbarui dokumen secara berkelompok.
Anda dapat memanggil Google Docs API menggunakan permintaan HTTP, atau dengan menggunakan pemanggilan metode 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 khusus bahasa.
Metode permintaan
Docs API mendukung metode berikut:
documents.create: Membuat dokumen Google Dokumen kosong.documents.get: Menampilkan instance lengkap dari dokumen yang ditentukan. Anda dapat mengurai JSON yang ditampilkan untuk mengekstrak isi dokumen, pemformatan, dan fitur lainnya.documents.batchUpdate: Mengirimkan daftar permintaan pengeditan untuk diterapkan secara atomik ke dokumen, dan menampilkan 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 ID
Dokumen.
Kumpulan update
Metode documents.batchUpdate
mengambil daftar
objek request, masing-masing
menentukan satu permintaan yang akan dijalankan. Misalnya, format paragraf lalu
tambahkan gambar inline. Setiap permintaan divalidasi sebelum diterapkan dan permintaan tersebut diproses sesuai urutan kemunculannya dalam permintaan batch.
Semua permintaan dalam batch update diterapkan secara atomik. Artinya, jika ada permintaan yang tidak valid, seluruh update tidak akan berhasil dan tidak ada perubahan (kemungkinan yang bergantung) yang akan 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 Docs API Anda dan
dokumentasi referensi
documents.batchUpdate untuk jenis permintaan dan respons.
Operasi update batch
Ada berbagai jenis permintaan update batch. Berikut adalah perincian jenis permintaan yang dikelompokkan ke dalam beberapa kategori.