Method: documents.batchUpdate

Menerapkan satu atau beberapa pembaruan pada dokumen.

Setiap request divalidasi sebelum diterapkan. Jika ada permintaan yang tidak valid, seluruh permintaan akan gagal dan tidak ada yang akan diterapkan.

Beberapa permintaan memiliki replies untuk memberikan sejumlah informasi tentang cara penerapannya. Permintaan lain tidak perlu menampilkan informasi; masing-masing mengembalikan jawaban kosong. Urutan balasan sesuai dengan permintaan.

Misalnya, Anda memanggil hdpi dengan empat update, dan hanya yang ketiga yang menampilkan informasi. Respons akan memiliki dua balasan kosong, balasan untuk permintaan ketiga, dan balasan kosong lainnya, dalam urutan tersebut.

Karena pengguna lain mungkin sedang mengedit dokumen, dokumen mungkin tidak benar-benar mencerminkan perubahan yang Anda buat: perubahan Anda mungkin berubah sehubungan dengan perubahan yang dilakukan kolaborator. Jika tidak ada kolaborator, dokumen akan memperlihatkan perubahan Anda. Bagaimanapun, pembaruan dalam permintaan Anda dijamin akan diterapkan bersama secara atomik.

Permintaan HTTP

POST https://docs.googleapis.com/v1/documents/{documentId}:batchUpdate

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
documentId

string

ID dokumen yang akan diperbarui.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Kolom
requests[]

object (Request)

Daftar pembaruan yang akan diterapkan ke dokumen.
writeControl

object (WriteControl)

Memberikan kontrol atas cara permintaan tulis dijalankan.

Isi respons

Pesan respons dari permintaan documents.batchUpdate.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "documentId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Kolom
documentId

string

ID dokumen tempat pembaruan diterapkan.
replies[]

object (Response)

Balasan atas pembaruan. Hal ini dipetakan 1:1 dengan pembaruan, meskipun balasan untuk beberapa permintaan mungkin kosong.
writeControl

object (WriteControl)

Kontrol tulis yang diperbarui setelah menerapkan permintaan.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/documents
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file

Untuk informasi selengkapnya, lihat Panduan otorisasi.

WriteControl

Memberikan kontrol atas cara permintaan tulis dijalankan.

Representasi JSON 
{

  // Union field control can be only one of the following:
  "requiredRevisionId": string,
  "targetRevisionId": string
  // End of list of possible types for union field control.
}
Kolom
Kolom union control. Menentukan revisi dokumen yang akan menjadi tujuan penulisan dan bagaimana permintaan harus berperilaku jika revisi tersebut bukan revisi dokumen saat ini. Jika tidak ada kolom yang ditentukan, update akan diterapkan ke revisi terbaru. control hanya dapat berupa salah satu dari berikut:
requiredRevisionId

string

revision ID opsional dari dokumen tempat permintaan tulis diterapkan. Jika ini bukan revisi terbaru dari dokumen ini, permintaan tidak akan diproses dan menampilkan error permintaan buruk 400.

Jika ID revisi yang diperlukan ditampilkan dalam respons, ini akan menunjukkan ID revisi dokumen setelah permintaan diterapkan.
targetRevisionId

string

Target opsional revision ID dari dokumen tempat permintaan tulis diterapkan.

Jika perubahan kolaborator terjadi setelah dokumen dibaca menggunakan API, perubahan yang dihasilkan oleh permintaan tulis ini akan diterapkan terhadap perubahan kolaborator. Hal ini menghasilkan revisi baru pada dokumen yang menggabungkan perubahan yang dilakukan kolaborator dan perubahan dalam permintaan, dengan server Dokumen yang menyelesaikan perubahan yang berkonflik. Saat menggunakan ID revisi target, klien API dapat dianggap sebagai kolaborator dokumen lain.

ID revisi target hanya dapat digunakan untuk menulis ke versi terbaru dokumen. Jika revisi target terlalu jauh dari revisi terbaru, permintaan tidak akan diproses dan menampilkan error permintaan buruk 400. Permintaan harus dicoba lagi setelah mengambil versi terbaru dokumen. Biasanya ID revisi tetap valid untuk digunakan sebagai revisi target selama beberapa menit setelah dibaca, tetapi untuk dokumen yang sering diedit, jendela ini mungkin lebih pendek.