Method: spreadsheets.getByDataFilter

Menampilkan spreadsheet pada ID yang diberikan. Pemanggil harus menentukan ID spreadsheet. Untuk mengetahui informasi selengkapnya, lihat Membaca, menulis, dan menelusuri metadata.

Metode ini berbeda dengan spreadsheets.get karena memungkinkan pemilihan subset data spreadsheet yang akan ditampilkan dengan menentukan parameter dataFilters. Beberapa DataFilters dapat ditentukan. Menentukan satu atau beberapa filter data akan menampilkan bagian spreadsheet yang berpotongan dengan rentang yang cocok dengan salah satu filter.

Secara default, data dalam petak tidak ditampilkan. Anda dapat menyertakan data petak dengan salah satu dari dua cara:

  • Tentukan masker kolom yang mencantumkan kolom yang Anda inginkan menggunakan parameter URL fields di HTTP.

  • Tetapkan parameter includeGridData ke true. Jika mask kolom ditetapkan, parameter includeGridData akan diabaikan.

Untuk spreadsheet besar, sebagai praktik terbaik, ambil hanya kolom spreadsheet tertentu yang Anda inginkan.

Permintaan HTTP

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

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
spreadsheetId

string

Spreadsheet yang akan diminta.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "includeGridData": boolean,
  "excludeTablesInBandedRanges": boolean
}
Kolom
dataFilters[]

object (DataFilter)

DataFilters yang digunakan untuk memilih rentang yang akan diambil dari spreadsheet.
includeGridData

boolean

Benar (true) jika data petak harus ditampilkan. Parameter ini diabaikan jika mask kolom ditetapkan dalam permintaan.
excludeTablesInBandedRanges

boolean

Benar jika tabel harus dikecualikan dalam rentang berjalur. Salah (False) jika tidak disetel.

Isi respons

Jika berhasil, isi respons memuat instance Spreadsheet.

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.