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 beberapa informasi tentang cara penerapannya. Permintaan lain tidak perlu menampilkan informasi; masing-masing menampilkan balasan kosong. Urutan balasan sesuai dengan urutan permintaan.

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

Karena pengguna lain mungkin mengedit dokumen, dokumen tersebut mungkin tidak mencerminkan perubahan Anda secara tepat: perubahan tersebut dapat diubah sesuai dengan perubahan kolaborator. Jika tidak ada kolaborator, dokumen harus mencerminkan perubahan Anda. Apa pun kasusnya, pembaruan dalam permintaan Anda dijamin akan diterapkan secara atomis.

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 untuk diterapkan pada 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 perubahan diterapkan.
replies[]

object (Response)

Balasan pembaruan. Ini dipetakan 1:1 dengan update, 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 mengetahui informasi selengkapnya, lihat Panduan otorisasi.

TulisKontrol

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 ditulis dan perilaku permintaan 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 pada dokumen tempat permintaan tulis diterapkan. Jika ini bukan revisi dokumen terbaru, permintaan tidak akan diproses dan akan menampilkan error permintaan 400 yang buruk.

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

string

Target opsional revision ID dari dokumen yang menerima permintaan tulis.

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

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