API Google Dokumen memungkinkan Anda membuat dan mengubah dokumen di Google Dokumen.
Aplikasi dapat berintegrasi dengan Docs API untuk membuat dokumen yang disempurnakan dari data yang disediakan pengguna dan sistem. Docs API memungkinkan Anda:
- Mengotomatiskan proses
- Membuat dokumentasi secara massal
- Memformat dokumen
- Membuat invoice atau kontrak
- Mengambil atribut tertentu dari objek
Berikut adalah daftar istilah umum yang digunakan dalam API Dokumen:
- ID Dokumen
ID unik untuk dokumen. String ini adalah string tertentu yang berisi huruf, angka, dan beberapa karakter khusus yang mereferensikan dokumen dan dapat berasal dari URL dokumen. ID dokumen akan stabil meskipun nama dokumen berubah. Untuk informasi selengkapnya tentang cara menemukan ID, baca ID Dokumen.
https://docs.google.com/document/d/DOCUMENT_ID/edit
- Elemen
Struktur yang membentuk dokumen. Elemen tingkat atas dokumen mencakup
Body
,DocumentStyle
, danList
.- Dokumen Google Workspace
File yang dibuat oleh aplikasi Google Workspace, seperti Google Dokumen. 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.- Indeks
Sebagian besar elemen dalam isi konten memiliki properti
startIndex
danendIndex
. Nilai ini menunjukkan offset awal dan akhir elemen, relatif terhadap awal segmen yang melingkupinya.- Gambar inline
Gambar yang muncul di aliran teks dalam dokumen. Dokumentasi bukanlah lampiran.
- Rentang bernama
Rentang teks yang berdekatan.
NamedRange
adalah kumpulan rentang dengannamedRangeId
yang sama. Rentang bernama memungkinkan developer mengaitkan bagian dokumen dengan label arbitrer ditentukan pengguna sehingga kontennya dapat dibaca atau diedit secara terprogram nanti. Dokumen dapat berisi beberapa rentang bernama dengan nama yang sama, tetapi setiap rentang bernama memiliki ID unik.- Segment
Body
,Header
,Footer
, atauFootnote
yang berisi elemen struktural atau konten. Indeks elemen dalam segmen relatif terhadap awal segmen tersebut.- Saran
Mengubah dokumen tanpa mengubah teks asli. Jika pemilik menyetujui saran Anda, mereka akan menggantikan teks aslinya.
Topik terkait
Untuk mempelajari cara mengembangkan aplikasi dengan Google Workspace API, termasuk menangani autentikasi dan otorisasi, lihat Mengembangkan di Google Workspace.
Untuk mendapatkan ringkasan konseptual dokumen, lihat Dokumen.
Untuk mempelajari cara mengonfigurasi dan menjalankan aplikasi Docs API, coba panduan memulai JavaScript.