Method: spreadsheets.batchUpdate

Menerapkan satu atau beberapa update pada spreadsheet.

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. Balasan akan mencerminkan permintaan tersebut. Misalnya, jika Anda menerapkan 4 pembaruan dan yang ketiga mendapat balasan, maka responsnya akan memiliki 2 balasan kosong, balasan yang sebenarnya, dan balasan kosong lainnya, dalam urutan tersebut.

Karena sifat kolaboratif spreadsheet, tidak ada jaminan bahwa spreadsheet akan mencerminkan dengan tepat perubahan Anda setelah ini selesai, namun dijamin bahwa pembaruan dalam permintaan akan diterapkan bersama secara atomik. Perubahan Anda dapat diubah sehubungan dengan perubahan kolaborator. Jika tidak ada kolaborator, {i>spreadsheet<i} akan menampilkan perubahan Anda.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
spreadsheetId

string

Spreadsheet tempat update diterapkan.

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. Hanya berarti jika includeSpreadsheetInResponse 'benar'.

responseIncludeGridData

boolean

True jika data petak harus ditampilkan. Hanya berarti jika includeSpreadsheetInResponse 'benar'. Parameter ini diabaikan jika mask kolom telah ditetapkan dalam permintaan.

Isi respons

Balasan untuk pembaruan batch suatu spreadsheet.

Jika berhasil, isi respons memuat data dengan struktur berikut:

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

string

Spreadsheet tempat pembaruan diterapkan.

replies[]

object (Response)

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

updatedSpreadsheet

object (Spreadsheet)

Spreadsheet setelah pembaruan diterapkan. Kolom ini hanya disetel 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 informasi selengkapnya, lihat Panduan otorisasi.