Method: spreadsheets.getByDataFilter

Zwraca arkusz kalkulacyjny o podanym identyfikatorze. Wywołujący musi podać identyfikator arkusza kalkulacyjnego. Więcej informacji znajdziesz w artykule Odczytywanie, zapisywanie i wyszukiwanie metadanych.

Ta metoda różni się od metody spreadsheets.get tym, że umożliwia wybieranie podzbiorów danych arkusza kalkulacyjnego do zwrócenia przez określenie parametru dataFilters. Można określić wiele wartości DataFilters. Określenie co najmniej 1 filtra danych zwraca części arkusza, które przecinają zakresy pasujące do dowolnego z filtrów.

Domyślnie dane w siatkach nie są zwracane. Dane siatki możesz uwzględnić na 2 sposoby:

  • Określ maskę pola z listą wybranych pól, używając parametru adresu URL fields w HTTP.

  • Ustaw parametr includeGridData na true. Jeśli ustawisz maskę pola, parametr includeGridData zostanie zignorowany.

W przypadku dużych arkuszy kalkulacyjnych zalecamy pobieranie tylko tych pól, które są potrzebne.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
spreadsheetId

string

Arkusz kalkulacyjny, o który chcesz poprosić.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

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

object (DataFilter)

Parametr DataFilters służy do wybierania zakresów do pobrania z arkusza kalkulacyjnego.
includeGridData

boolean

Wartość „prawda”, jeśli mają zostać zwrócone dane siatki. Ten parametr jest ignorowany, jeśli w żądaniu ustawiono maskę pola.
excludeTablesInBandedRanges

boolean

Wartość true, jeśli tabele mają być wykluczone z zakresów pasmowych. Jeśli nie jest ustawiona, ma wartość „Fałsz”.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Spreadsheet.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

Więcej informacji znajdziesz w przewodniku po autoryzacji.