Method: spreadsheets.values.batchUpdate

Menetapkan nilai dalam satu atau beberapa rentang spreadsheet. Pemanggil harus menentukan ID spreadsheet, valueInputOption, dan satu atau beberapa ValueRanges.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
spreadsheetId

string

ID spreadsheet yang akan diperbarui.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "valueInputOption": enum (ValueInputOption),
  "data": [
    {
      object (ValueRange)
    }
  ],
  "includeValuesInResponse": boolean,
  "responseValueRenderOption": enum (ValueRenderOption),
  "responseDateTimeRenderOption": enum (DateTimeRenderOption)
}
Kolom
valueInputOption

enum (ValueInputOption)

Bagaimana data input harus ditafsirkan.

data[]

object (ValueRange)

Nilai baru yang akan diterapkan ke spreadsheet.

includeValuesInResponse

boolean

Menentukan apakah respons update harus menyertakan nilai sel yang diupdate. Secara default, respons tidak menyertakan nilai yang diperbarui. Kolom updatedData dalam setiap BatchUpdateValuesResponse.responses berisi nilai yang diupdate. Jika rentang yang akan ditulis lebih besar dari rentang yang sebenarnya ditulis, respons akan menyertakan semua nilai dalam rentang yang diminta (tidak termasuk baris dan kolom kosong di akhir).

responseValueRenderOption

enum (ValueRenderOption)

Menentukan bagaimana nilai dalam respons harus dirender. Opsi render default adalah FORMATTED_VALUE.

responseDateTimeRenderOption

enum (DateTimeRenderOption)

Menentukan bagaimana tanggal, waktu, dan durasi dalam respons harus dirender. Nilai ini akan diabaikan jika responseValueRenderOption adalah FORMATTED_VALUE. Opsi render dateTime default adalah SERIAL_NUMBER.

Isi respons

Respons saat memperbarui rentang nilai dalam spreadsheet.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "spreadsheetId": string,
  "totalUpdatedRows": integer,
  "totalUpdatedColumns": integer,
  "totalUpdatedCells": integer,
  "totalUpdatedSheets": integer,
  "responses": [
    {
      object (UpdateValuesResponse)
    }
  ]
}
Kolom
spreadsheetId

string

Spreadsheet tempat pembaruan diterapkan.

totalUpdatedRows

integer

Jumlah total baris dengan minimal satu sel dalam baris yang diperbarui.

totalUpdatedColumns

integer

Jumlah total kolom dengan minimal satu sel dalam kolom yang telah diperbarui.

totalUpdatedCells

integer

Jumlah total sel yang diperbarui.

totalUpdatedSheets

integer

Jumlah total sheet dengan setidaknya satu sel dalam sheet yang diperbarui.

responses[]

object (UpdateValuesResponse)

Satu UpdateValuesResponse per rentang yang diminta, dalam urutan yang sama dengan permintaan yang muncul.

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.