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. Keduanya secara umum 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 konten 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, yang dapat Anda gunakan untuk membaca documentId. Untuk mengetahui informasi selengkapnya tentang documentId, lihat Dokumen
ID.
Dokumen yang dipublikasikan
Anda tidak dapat menggunakan metode documents.get untuk mengambil dokumen yang dipublikasikan. Setelah dipublikasikan, dokumen publik menggunakan format URL yang berbeda dengan documentId publik yang berbeda. Upaya untuk menggunakan documentId publik dengan metode documents.get akan menampilkan respons kode status HTTP 404.
Demikian pula, Anda tidak dapat menggunakan metode Drive API
files.copy untuk menyalin dokumen yang
dipublikasikan.
Untuk mengambil atau menyalin dokumen yang dipublikasikan, Anda harus menggunakan documentId asli. Tidak ada metode untuk mengekstrak documentId asli dari URL yang dipublikasikan.
Untuk mengetahui informasi selengkapnya, lihat:
Update batch
Metode
documents.batchUpdate
menggunakan 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 kemunculannya dalam permintaan batch.
Semua permintaan dalam kumpulan update diterapkan secara atomik. Artinya, jika ada permintaan yang tidak valid, seluruh update akan gagal dan tidak ada perubahan (yang mungkin bergantung) yang diterapkan.
Beberapa metode documents.batchUpdate memberikan respons dengan informasi tentang permintaan yang diterapkan. Metode ini menampilkan isi respons
yang berisi daftar
response objek.
Permintaan lain tidak perlu menampilkan informasi dan menampilkan balasan kosong. Objek dalam daftar respons menempati urutan indeks yang sama dengan permintaan yang sesuai.
Pola umum 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 membuat batch panggilan Docs API dan
documents.batchUpdate
dokumentasi referensi untuk jenis permintaan dan respons.
Operasi update batch
Ada berbagai jenis permintaan update batch. Berikut adalah rincian jenis permintaan, yang dikelompokkan ke dalam kategori yang berbeda.