Google Docs API memungkinkan Anda membuat dan memodifikasi dokumen.
Aplikasi dapat terintegrasi dengan Docs API untuk membuat dokumen berkualitas tinggi dari data yang disediakan sistem dan pengguna. 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:
- Gunakan documents.create untuk membuat dokumen.
- Gunakan documents.get untuk mengambil konten dokumen tertentu.
- Gunakan documents.batchUpdate untuk melakukan update secara atomik pada dokumen yang ditentukan.
Metode get dan batchUpdate memerlukan documentId (lihat di bawah) sebagai parameter untuk menentukan dokumen target. Metode create menampilkan instance dokumen yang dibuat, tempat Anda dapat membaca ID-nya.
Kumpulan update
Metode batchUpdate mengambil daftar objek permintaan, dan membuat pembaruan
sesuai dengan urutan kemunculannya dalam permintaan batch. Update
dalam update batch diterapkan secara atomis. Artinya, jika ada permintaan yang tidak valid, seluruh update tidak berhasil dan tidak ada perubahan (yang mungkin bergantung pada) yang diterapkan.
Metode batchUpdate menampilkan daftar objek respons. Objek dalam daftar ini menempati urutan indeks yang sama dengan permintaan yang sesuai.
Lihat praktik terbaik permintaan batch untuk mengetahui cara mengelompokkan panggilan API dan dokumentasi referensi batchUpdate untuk jenis permintaan dan respons tersebut.
ID Dokumen
ID dokumen mereferensikan sebuah dokumen dan ID tersebut 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 konten dokumen, setiap pembaruan akan terjadi di 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 lebih lanjut dan cara menggunakannya, lihat panduan konsep Struktur dokumen Google Dokumen.
Alur kerja pembaruan dokumen
Membuat dan mengisi dokumen baru sangat mudah, karena tidak ada konten yang perlu dikhawatirkan dan tidak ada kolaborator yang dapat mengubah status dokumen. Secara konseptual, ini berfungsi seperti yang ditunjukkan pada diagram urutan berikut:
Memperbarui dokumen yang ada menjadi lebih rumit. Sebelum dapat melakukan panggilan yang bermakna untuk memperbarui dokumen, Anda perlu mengetahui status dokumen saat ini: elemen apa yang membentuknya, konten apa yang terdapat dalam elemen tersebut, dan di mana semua item ini berada dalam dokumen. Diagram urutan berikut menunjukkan cara kerjanya:
Diagram ini tidak mempertimbangkan alur kerja saat pembaruan serentak oleh kolaborator lain dilakukan dalam dokumen yang sama. Lihat Merencanakan kolaborasi untuk diskusi tentang topik ini.