Method: spreadsheets.getByDataFilter

Menampilkan spreadsheet dengan ID yang diberikan. Pemanggil harus menentukan ID spreadsheet.

Metode ini berbeda dengan spreadsheet.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 2 cara berikut:

  • Tentukan mask kolom yang mencantumkan kolom yang diinginkan menggunakan parameter URL fields di HTTP

  • Setel parameter includeGridData ke benar (true). Jika mask kolom ditetapkan, parameter includeGridData akan diabaikan

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

Permintaan HTTP

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

URL 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
}
Kolom
dataFilters[]

object (DataFilter)

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

boolean

True jika data petak harus ditampilkan. Parameter ini diabaikan jika mask kolom ditetapkan dalam permintaan.

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.