Praktik terbaik untuk hasil terbaik

Ada beberapa prinsip yang harus Anda ikuti saat menggunakan Google Docs API. Hal ini mencakup:

  • Edit mundur untuk efisiensi
  • Merencanakan kolaborasi
  • Memastikan konsistensi status dengan WriteControl

Bagian berikut menjelaskan prinsip-prinsip tersebut.

Edit mundur untuk efisiensi

Dalam satu panggilan ke metode BatchUpdate, urutkan permintaan Anda dalam urutan menurun dari lokasi indeks. Dengan demikian, Anda tidak perlu menghitung perubahan indeks karena penyisipan dan penghapusan.

Merencanakan kolaborasi

Status dokumen akan berubah. Di antara satu panggilan metode dan yang lainnya, kolaborator lain mungkin memperbarui dokumen, seperti yang ditampilkan dalam diagram berikut:

Cara dokumen dapat berubah di antara panggilan metode.

Hal ini dapat menyebabkan error jika indeks Anda salah. Karena ada beberapa pengguna yang mengedit dokumen menggunakan UI, Google Dokumen menangani masalah ini secara transparan, tetapi sebagai klien API, aplikasi Anda harus mengelola tugas ini. Meskipun Anda tidak mengantisipasi kolaborasi pada dokumen, penting untuk memprogram secara defensif dan memastikan status dokumen tetap konsisten. Untuk satu cara memastikan konsistensi, tinjau bagian WriteControl di bawah.

Memastikan konsistensi status dengan WriteControl

Saat Anda membaca lalu memperbarui dokumen, Anda dapat memastikan dokumen tersebut belum diperbarui dengan menggunakan kolom WriteControl dalam metode BatchUpdate. Tindakan ini memungkinkan Anda mengedit dokumen hanya jika versinya belum berubah. Berikut ini cara Anda menggunakannya:

  1. Dapatkan dokumen dan simpan string revisionId yang disertakan di dalamnya.
  2. Tulis permintaan update Anda.
  3. Sertakan objek WriteControl dengan requiredRevisionId yang ditetapkan ke string yang Anda simpan.
  4. Saat Anda memanggil BatchUpdate, jika revisi dokumen telah diubah, akan ditampilkan error dan tidak melakukan pembaruan.