Method: spreadsheets.values.batchGetByDataFilter

Menampilkan satu atau beberapa rentang nilai yang cocok dengan filter data yang ditentukan. Untuk mengetahui informasi selengkapnya, lihat Membaca, menulis, dan menelusuri metadata.

Pemanggil harus menentukan ID spreadsheet dan satu atau beberapa DataFilters. Rentang yang cocok dengan salah satu filter data dalam permintaan akan ditampilkan.

Permintaan HTTP

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

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
spreadsheetId

string

ID spreadsheet untuk mengambil data.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "majorDimension": enum (Dimension),
  "valueRenderOption": enum (ValueRenderOption),
  "dateTimeRenderOption": enum (DateTimeRenderOption)
}
Kolom
dataFilters[]

object (DataFilter)

Filter data yang digunakan untuk mencocokkan rentang nilai yang akan diambil. Rentang yang cocok dengan salah satu filter data yang ditentukan disertakan dalam respons.
majorDimension

enum (Dimension)

Dimensi utama yang harus digunakan hasil.

Misalnya, jika data spreadsheet adalah: A1=1,B1=2,A2=3,B2=4, maka permintaan yang memilih rentang tersebut dan menetapkan majorDimension=ROWS akan menampilkan [[1,2],[3,4]], sedangkan permintaan yang menetapkan majorDimension=COLUMNS akan menampilkan [[1,3],[2,4]].
valueRenderOption

enum (ValueRenderOption)

Cara nilai harus ditampilkan dalam output. Opsi render default adalah FORMATTED_VALUE.
dateTimeRenderOption

enum (DateTimeRenderOption)

Cara tanggal, waktu, dan durasi harus ditampilkan dalam output. Nilai ini diabaikan jika valueRenderOption adalah FORMATTED_VALUE. Opsi rendering dateTime default adalah SERIAL_NUMBER.

Isi respons

Respons saat mengambil lebih dari satu rentang nilai dalam spreadsheet yang dipilih oleh DataFilters.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "spreadsheetId": string,
  "valueRanges": [
    {
      object (MatchedValueRange)
    }
  ]
}
Kolom
spreadsheetId

string

ID spreadsheet tempat data diambil.
valueRanges[]

object (MatchedValueRange)

Nilai yang diminta dengan daftar filter data yang cocok dengannya.

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.

MatchedValueRange

Rentang nilai yang cocok dengan satu atau beberapa pemfilter data.

Representasi JSON 
{
  "valueRange": {
    object (ValueRange)
  },
  "dataFilters": [
    {
      object (DataFilter)
    }
  ]
}
Kolom
valueRange

object (ValueRange)

Nilai yang cocok dengan DataFilter.
dataFilters[]

object (DataFilter)

DataFilters dari permintaan yang cocok dengan rentang nilai.