Method: spreadsheets.getByDataFilter

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

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 filter mana pun.

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

  • Tentukan field mask yang mencantumkan kolom yang Anda inginkan menggunakan parameter URL fields di HTTP

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

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

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 digunakan untuk memilih rentang yang akan diambil dari spreadsheet.
includeGridData

boolean

True jika data petak harus ditampilkan. Parameter ini diabaikan jika mask kolom telah 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 informasi selengkapnya, lihat Panduan otorisasi.