Method: spreadsheets.batchUpdate

Menerapkan satu atau beberapa pembaruan pada spreadsheet.

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

Beberapa permintaan memiliki replies untuk memberikan beberapa informasi tentang cara penerapannya. Balasan akan mencerminkan permintaan tersebut. Misalnya, jika Anda menerapkan 4 pembaruan dan yang ketiga memiliki balasan, respons akan memiliki 2 balasan kosong, yang sebenarnya balasan, dan balasan kosong lainnya, dalam urutan tersebut.

Karena sifat spreadsheet yang kolaboratif, tidak ada jaminan bahwa spreadsheet akan mencerminkan perubahan Anda secara tepat setelah perubahan ini. Namun, dijamin bahwa pembaruan dalam permintaan tersebut akan diterapkan secara atomis. Perubahan Anda dapat diubah sesuai dengan perubahan kolaborator. Jika tidak ada kolaborator, spreadsheet akan mencerminkan perubahan Anda.

Permintaan HTTP

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:batchUpdate

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
spreadsheetId

string

Spreadsheet yang akan diterapkan pembaruan.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "requests": [
    {
      object (Request)
    }
  ],
  "includeSpreadsheetInResponse": boolean,
  "responseRanges": [
    string
  ],
  "responseIncludeGridData": boolean
}
Kolom
requests[]

object (Request)

Daftar pembaruan yang akan diterapkan ke spreadsheet. Permintaan akan diterapkan sesuai urutan yang ditentukan. Jika ada permintaan yang tidak valid, tidak ada permintaan yang akan diterapkan.

includeSpreadsheetInResponse

boolean

Menentukan apakah respons update harus menyertakan resource spreadsheet.

responseRanges[]

string

Membatasi rentang yang disertakan dalam spreadsheet respons. Artinya hanya jika includeSpreadsheetInResponse bernilai 'true'.

responseIncludeGridData

boolean

True jika data petak harus ditampilkan. Artinya hanya jika includeSpreadsheetInResponse bernilai 'true'. Parameter ini diabaikan jika mask kolom ditetapkan dalam permintaan.

Isi respons

Balasan untuk batch yang memperbarui spreadsheet.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "spreadsheetId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "updatedSpreadsheet": {
    object (Spreadsheet)
  }
}
Kolom
spreadsheetId

string

Spreadsheet yang menerapkan pembaruan tersebut.

replies[]

object (Response)

Balasan pembaruan. Ini dipetakan 1:1 dengan update, meskipun balasan untuk beberapa permintaan mungkin kosong.

updatedSpreadsheet

object (Spreadsheet)

Spreadsheet setelah pembaruan diterapkan. Ini hanya ditetapkan jika BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response adalah true.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.