Panduan ini memperkenalkan konsep seperti metode utama yang membentuk Google Docs API, cara mengakses dokumen, dan alur kerja saat membuat dokumen.
Metode API
Resource documents
menyediakan
metode yang Anda gunakan untuk memanggil Docs API. Metode berikut memungkinkan Anda
membuat, membaca, dan memperbarui dokumen Dokumen:
- Gunakan metode
documents.create
untuk membuat dokumen. - Gunakan metode
documents.get
untuk mengambil isi dokumen yang ditentukan. - Gunakan metode
documents.batchUpdate
untuk menjalankan serangkaian update pada dokumen tertentu secara atomik.
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 permintaan dan
metode respons Docs API, lihat Permintaan dan
respons.
ID dokumen
documentId
adalah ID unik untuk dokumen dan dapat berasal dari URL dokumen. String ini adalah string tertentu yang berisi huruf, angka, dan
beberapa karakter khusus. ID dokumen bersifat stabil, meskipun nama dokumen berubah.
https://docs.google.com/document/d/DOCUMENT_ID/edit
Ekspresi reguler berikut dapat digunakan untuk mengekstrak documentId
dari URL Google Dokumen:
/document/d/([a-zA-Z0-9-_]+)
Jika Anda sudah terbiasa dengan Google Drive API, documentId
sesuai dengan id
dalam resource files
.
Mengelola dokumen di Google Drive
File dokumen disimpan di Google Drive, layanan penyimpanan berbasis cloud kami. Meskipun Docs API memiliki metode mandiri, Anda juga perlu
menggunakan metode Google Drive API untuk berinteraksi dengan file Dokumen
pengguna. Misalnya, untuk menyalin file Dokumen, gunakan metode files.copy
Drive API. Untuk informasi selengkapnya, lihat Menyalin dokumen
yang ada.
Secara default, saat menggunakan Docs API, dokumen baru disimpan ke folder root pengguna di Drive. Ada opsi untuk menyimpan file ke folder Drive. Untuk mengetahui informasi selengkapnya, lihat Bekerja dengan folder Google Drive.
Menggunakan file Dokumen
Untuk mengambil dokumen dari Drive Saya milik pengguna, sering kali Anda harus menggunakan metode files.list
Drive terlebih dahulu untuk mengambil ID sebuah file. Memanggil metode tanpa parameter apa pun akan menampilkan daftar semua
file dan folder, termasuk ID, untuk pengguna.
Jenis MIME dokumen menunjukkan jenis dan format data. Format jenis MIME untuk Dokumen adalah application/vnd.google-apps.document
. Untuk mengetahui daftar
jenis MIME, lihat jenis MIME yang didukung Google Workspace dan
Google Drive.
Untuk menelusuri file Dokumen dalam Drive Saya berdasarkan jenis MIME saja, tambahkan filter string kueri berikut:
q: mimeType = 'application/vnd.google-apps.document'
Untuk mengetahui informasi selengkapnya tentang filter string kueri, baca Menelusuri file dan folder.
Setelah Anda mengetahui documentId
, gunakan metode documents.get
untuk mengambil instance lengkap dari dokumen yang ditentukan. Untuk mengetahui informasi selengkapnya, lihat
Permintaan dan respons.
Untuk mengekspor konten byte dokumen Google Workspace, gunakan metode files.export
Drive dengan documentId
file yang akan diekspor, dan jenis MIME ekspor yang benar. Untuk mengetahui informasi selengkapnya, lihat Mengekspor
konten dokumen
Google Workspace.
Membandingkan metode Get
dan List
Tabel berikut menjelaskan perbedaan antara metode Drive dan Dokumen, serta data yang ditampilkan:
Operator | Deskripsi | Penggunaan |
---|---|---|
drive.files.get |
Mendapatkan metadata file berdasarkan ID. Menampilkan instance resource files . |
Mendapatkan metadata untuk file tertentu. |
drive.files.list |
Mendapatkan file pengguna. Menampilkan daftar file. | Dapatkan daftar file pengguna saat Anda tidak yakin file mana yang harus Anda ubah. |
docs.documents.get |
Mendapatkan versi terbaru dari dokumen yang ditentukan, termasuk semua pemformatan dan teks. Menampilkan instance resource documents . |
Dapatkan dokumen untuk ID dokumen tertentu. |
Alur kerja pembuatan dokumen
Membuat dan mengisi dokumen baru sangatlah 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:
Pada Gambar 1, pengguna yang berinteraksi dengan
resource documents
memiliki alur informasi
berikut:
- Aplikasi memanggil
metode
documents.create
di server web. - Server web mengirimkan respons HTTP yang berisi instance
dokumen yang dibuat sebagai resource
documents
. - Secara opsional, aplikasi memanggil metode
documents.batchUpdate
untuk melakukan kumpulan permintaan edit secara atomik guna mengisi dokumen dengan data. - Server web mengirimkan respons HTTP. Beberapa metode
documents.batchUpdate
memberikan isi respons dengan informasi tentang permintaan yang diterapkan, sedangkan metode yang lain menampilkan respons kosong.
Alur kerja pembaruan dokumen
Memperbarui dokumen yang ada lebih rumit. Sebelum dapat melakukan panggilan yang bermakna untuk memperbarui dokumen, Anda harus mengetahui statusnya saat ini: elemen apa saja yang menyusunnya, konten apa yang ada dalam elemen tersebut, dan urutan elemen dalam dokumen. Diagram urutan berikut menunjukkan cara kerjanya:
Pada Gambar 2, pengguna yang berinteraksi dengan resource documents
memiliki
alur informasi berikut:
- Aplikasi memanggil metode
documents.get
di server web, dengandocumentId
file yang akan ditemukan. - Server web mengirimkan respons HTTP yang berisi instance dokumen yang ditentukan sebagai resource
documents
. JSON yang ditampilkan berisi konten dokumen, format, dan fitur lainnya. - Aplikasi akan mengurai JSON agar pengguna dapat menentukan konten atau format yang akan diupdate.
- Aplikasi memanggil metode
documents.batchUpdate
untuk melakukan serangkaian permintaan edit secara atomik guna memperbarui dokumen. - Server web mengirimkan respons HTTP. Beberapa metode
documents.batchUpdate
memberikan isi respons dengan informasi tentang permintaan yang diterapkan, sedangkan metode yang lain menampilkan respons kosong.
Diagram ini tidak mempertimbangkan alur kerja yang update serentak oleh kolaborator lain dibuat dalam dokumen yang sama. Untuk informasi selengkapnya, lihat bagian praktik terbaik Merencanakan kolaborasi.
Topik terkait
- Struktur dokumen Google Dokumen
- Permintaan dan respons
- Aturan dan perilaku pengeditan struktural
- Praktik terbaik untuk hasil terbaik