Panduan ini memperkenalkan metode permintaan dan respons utama yang membentuk Google Docs API dan cara Anda dapat memperbarui dokumen secara massal.
Anda dapat memanggil Google Docs API menggunakan permintaan HTTP, atau dengan menggunakan pemanggilan metode di library klien khusus bahasa. Keduanya setara secara luas.
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 per bahasa.
Metode permintaan
Docs API mendukung metode berikut:
documents.create: Membuat dokumen Google Dokumen kosong.documents.get: Menampilkan instance lengkap dokumen yang ditentukan. Anda dapat mengurai JSON yang ditampilkan untuk mengekstrak konten dokumen, pemformatan, dan fitur lainnya.documents.batchUpdate: Kirimkan daftar permintaan pengeditan untuk diterapkan secara atomik ke dokumen, dan tampilkan 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.
Perhatikan bahwa Anda tidak dapat menggunakan metode documents.get untuk mengambil dokumen
yang dipublikasikan. Setelah dipublikasikan, dokumen publik menggunakan format URL yang berbeda. Upaya
untuk menggunakan documentId baru URL dengan metode documents.get akan menampilkan
respons kode status HTTP 404. Tidak ada metode untuk mengambil documentId
asli dari URL yang dipublikasikan. Untuk mengatasi masalah ini, Anda dapat menggunakan Drive API untuk menyalin dokumen yang dipublikasikan ke dokumen bersama, lalu mengakses file ini. Untuk informasi selengkapnya, lihat Menjadikan Google Dokumen, Spreadsheet, Slide, & Formulir bersifat publik.
Update batch
Metode
documents.batchUpdate
mengambil daftar
objek request, yang masing-masing
menentukan satu permintaan untuk dilakukan. Misalnya, format paragraf, lalu
tambahkan gambar inline. Setiap permintaan divalidasi sebelum diterapkan dan
permintaan diproses sesuai dengan urutan kemunculan dalam permintaan batch.
Semua permintaan dalam update batch diterapkan secara atomik. Artinya, jika ada permintaan yang tidak valid, seluruh update tidak akan berhasil 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 lengkap tentang
cara mengelompokkan panggilan Docs API dan dokumentasi referensi
documents.batchUpdate
untuk jenis permintaan dan respons.
Operasi update batch
Ada berbagai jenis permintaan pembaruan batch. Berikut adalah perincian jenis permintaan, yang dikelompokkan ke dalam berbagai kategori.