API Google Docs memungkinkan Anda membuat dan memodifikasi dokumen.
Aplikasi dapat berintegrasi dengan Docs API untuk membuat dokumen yang disempurnakan dari data yang disediakan oleh pengguna dan sistem. API ini memungkinkan Anda untuk:
- Mengotomatiskan proses
- Membuat dokumentasi secara massal
- Membuat invoice atau kontrak
Ringkasan API
Resource documents menyediakan metode yang Anda gunakan untuk memanggil Docs API.
Metode API
Metode berikut memungkinkan Anda membuat, membaca, dan memperbarui dokumen Google Dokumen:
- Menggunakan documents.create untuk membuat dokumen.
- Gunakan documents.get untuk mengambil konten dokumen tertentu.
- Gunakan documents.ggplot untuk melakukan serangkaian update pada dokumen yang ditentukan secara atomik.
Metode get dan batchUpdate memerlukan documentId (lihat di bawah) sebagai parameter untuk menentukan dokumen target. Metode create menampilkan instance dokumen yang dibuat, yang darinya Anda dapat membaca ID-nya.
Kumpulan update
Metode batchUpdate mengambil daftar objek permintaan, dan membuat pembaruan
sesuai dengan urutan yang sama dengan saat muncul dalam permintaan batch. Update dalam batch update diterapkan secara atomik. Artinya, jika ada permintaan yang tidak valid, seluruh pembaruan akan gagal dan tidak ada satu pun perubahan (yang berpotensi bergantung) yang diterapkan.
Metode batchUpdate akan menampilkan daftar objek respons. Objek dalam
daftar ini menempati urutan indeks yang sama dengan permintaan terkait.
Lihat praktik terbaik permintaan batch untuk mengetahui cara mengelompokkan panggilan API sekaligus dan dokumentasi referensi googleplay untuk jenis permintaan dan respons.
ID Dokumen
ID dokumen mereferensikan dokumen dan dapat berasal dari URL:
https://docs.google.com/document/d/documentId/edit
documentId adalah string unik yang berisi huruf, angka, dan beberapa karakter
khusus. Ekspresi reguler berikut dapat digunakan untuk mengekstrak ID dokumen dari URL Google Dokumen:
/document/d/([a-zA-Z0-9-_]+)
Jika Anda sudah terbiasa dengan Google Drive API, documentId akan sesuai dengan
ID resource
File.
Lokasi dalam dokumen: indeks
Saat Anda membuat pembaruan pada isi dokumen, setiap pembaruan terjadi di suatu lokasi atau di seluruh rentang dalam dokumen. Lokasi dan rentang ini ditentukan menggunakan indeks, yang mewakili offset dalam segmen dokumen yang memuatnya. Untuk mempelajari indeks dan cara menggunakannya lebih lanjut, lihat panduan konsep Struktur dokumen Google Dokumen.
Alur kerja pembaruan dokumen
Membuat dan mengisi dokumen baru menjadi mudah, karena tidak ada konten yang perlu dikhawatirkan dan tidak ada kolaborator yang dapat mengubah status dokumen. Secara konseptual, ini berfungsi seperti yang ditunjukkan dalam diagram urutan berikut:
Memperbarui dokumen yang ada lebih rumit. Sebelum dapat melakukan panggilan yang berarti untuk memperbarui dokumen, Anda perlu mengetahui status dokumen saat ini: elemen apa saja yang menyusunnya, konten apa yang ada dalam elemen tersebut, dan lokasi semua item tersebut dalam dokumen. Diagram urutan berikut menunjukkan cara kerjanya:
Diagram ini tidak mempertimbangkan alur kerja saat pembaruan serentak oleh kolaborator lain dibuat dalam dokumen yang sama. Lihat Merencanakan kolaborasi untuk membahas topik ini.