Method: spreadsheets.batchUpdate

Menerapkan satu atau beberapa pembaruan ke 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 memberi Anda beberapa informasi tentang cara penerapannya. Balasan akan mencerminkan permintaan. Misalnya, jika Anda menerapkan 4 pembaruan dan balasan ketiga memiliki balasan, maka respons akan memiliki 2 balasan kosong, balasan sebenarnya, dan balasan kosong lainnya, dalam urutan tersebut.

Karena spreadsheet bersifat kolaboratif, tidak ada jaminan bahwa spreadsheet akan mencerminkan perubahan Anda dengan tepat setelah ini selesai, namun dijamin bahwa pembaruan dalam permintaan akan diterapkan bersama-sama secara atomik. Perubahan Anda mungkin akan diubah sehubungan dengan perubahan kolaborator. Jika tidak ada kolaborator, {i>spreadsheet<i} harus menunjukkan perubahan yang Anda buat.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
spreadsheetId

string

Spreadsheet yang akan menerapkan 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 untuk 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 pembaruan harus menyertakan resource spreadsheet.

responseRanges[]

string

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

responseIncludeGridData

boolean

Benar jika data petak akan ditampilkan. Bermanfaat hanya jika includeSpreadsheetInResponse bernilai 'true'. Parameter ini diabaikan jika mask kolom ditetapkan dalam permintaan.

Isi respons

Balasan untuk pembaruan spreadsheet dalam jumlah banyak.

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 update. Pemetaan ini 1:1 dengan pembaruan, meskipun balasan untuk beberapa permintaan mungkin kosong.

updatedSpreadsheet

object (Spreadsheet)

Spreadsheet setelah pembaruan diterapkan. 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.