Method: spreadsheets.values.batchGetByDataFilter

Menampilkan satu atau beberapa rentang nilai yang cocok dengan filter data yang ditentukan. Pemanggil harus menentukan ID spreadsheet dan satu atau beberapa DataFilters. Rentang yang cocok dengan filter data mana pun dalam permintaan akan ditampilkan.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
spreadsheetId

string

ID spreadsheet tempat data diambil.

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 filter data yang ditentukan akan 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, 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 akan ditampilkan dalam output. Opsi render default adalah FORMATTED_VALUE.
dateTimeRenderOption

enum (DateTimeRenderOption)

Bagaimana tanggal, waktu, dan durasi harus ditampilkan dalam output. Nilai ini akan diabaikan jika valueRenderOption adalah FORMATTED_VALUE. Opsi render 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 informasi selengkapnya, lihat Panduan otorisasi.

MatchedValueRange

Rentang nilai yang dicocokkan oleh satu atau beberapa pemilah 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.