Method: spreadsheets.values.batchUpdateByDataFilter

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

Permintaan HTTP

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

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 (DataFilterValueRange)
    }
  ],
  "includeValuesInResponse": boolean,
  "responseValueRenderOption": enum (ValueRenderOption),
  "responseDateTimeRenderOption": enum (DateTimeRenderOption)
}
Kolom
valueInputOption

enum (ValueInputOption)

Cara data input harus ditafsirkan.
data[]

object (DataFilterValueRange)

Nilai baru yang akan diterapkan ke spreadsheet. Jika lebih dari satu rentang cocok dengan DataFilter yang ditentukan, nilai yang ditentukan akan diterapkan ke semua rentang tersebut.
includeValuesInResponse

boolean

Menentukan apakah respons pembaruan harus menyertakan nilai sel yang diperbarui. Secara default, respons tidak menyertakan nilai yang diperbarui. Kolom updatedData dalam setiap BatchUpdateValuesResponse.responses berisi nilai yang diperbarui. 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 cara nilai dalam respons harus dirender. Opsi render default-nya adalah FORMATTED_VALUE.
responseDateTimeRenderOption

enum (DateTimeRenderOption)

Menentukan cara tanggal, waktu, dan durasi dalam respons harus dirender. Nilai ini akan diabaikan jika responseValueRenderOption adalah FORMATTED_VALUE. Opsi rendering dateTime default-nya adalah SERIAL_NUMBER.

Isi respons

Respons saat memperbarui rentang nilai di spreadsheet.

Jika berhasil, isi respons memuat data dengan struktur berikut:

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

string

Spreadsheet tempat pembaruan diterapkan.
totalUpdatedRows

integer

Jumlah total baris tempat setidaknya satu sel dalam baris diperbarui.
totalUpdatedColumns

integer

Jumlah total kolom tempat setidaknya satu sel di kolom diperbarui.
totalUpdatedCells

integer

Jumlah total sel yang diperbarui.
totalUpdatedSheets

integer

Jumlah total sheet tempat setidaknya satu sel di sheet diperbarui.
responses[]

object (UpdateValuesByDataFilterResponse)

Respons untuk setiap rentang diperbarui.

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.

DataFilterValueRange

Rentang nilai yang lokasinya ditentukan oleh DataFilter.

Representasi JSON 
{
  "dataFilter": {
    object (DataFilter)
  },
  "majorDimension": enum (Dimension),
  "values": [
    array
  ]
}
Kolom
dataFilter

object (DataFilter)

Filter data yang menjelaskan lokasi nilai dalam spreadsheet.
majorDimension

enum (Dimension)

Dimensi utama nilai.
values[]

array (ListValue format)

Data yang akan ditulis. Jika nilai yang diberikan melebihi rentang yang cocok dengan filter data, permintaan akan gagal. Jika nilai yang diberikan kurang dari rentang yang cocok, hanya nilai yang ditentukan yang akan ditulis, nilai yang ada dalam rentang yang cocok tidak akan terpengaruh.

UpdateValuesByDataFilterResponse

Respons saat memperbarui rentang nilai berdasarkan filter data di spreadsheet.

Representasi JSON 
{
  "updatedRange": string,
  "updatedRows": integer,
  "updatedColumns": integer,
  "updatedCells": integer,
  "dataFilter": {
    object (DataFilter)
  },
  "updatedData": {
    object (ValueRange)
  }
}
Kolom
updatedRange

string

Rentang (dalam notasi A1) tempat update diterapkan.
updatedRows

integer

Jumlah baris yang setidaknya satu selnya diperbarui.
updatedColumns

integer

Jumlah kolom yang setidaknya satu selnya diperbarui.
updatedCells

integer

Jumlah sel yang diperbarui.
dataFilter

object (DataFilter)

Filter data yang memilih rentang yang diperbarui.
updatedData

object (ValueRange)

Nilai sel dalam rentang yang cocok dengan dataFilter setelah semua pembaruan diterapkan. Ini hanya disertakan jika kolom includeValuesInResponse permintaan adalah true.