Method: spreadsheets.getByDataFilter

Zwraca arkusz kalkulacyjny o podanym identyfikatorze. Wywołujący musi podać identyfikator arkusza kalkulacyjnego.

Ta metoda różni się od metody spreadsheets.get tym, że pozwala wybrać, które podzbiory danych z arkusza kalkulacyjnego mają zostać zwrócone, przez określenie parametru dataFilters. Można określić wiele wartości DataFilters. Określenie co najmniej 1 filtra danych powoduje zwrócenie części arkusza kalkulacyjnego, które pokrywają się z zakresami pasującymi do dowolnego z tych filtrów.

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

  • Określ maskę pola, podając odpowiednie pola za pomocą parametru adresu URL fields w HTTP.

  • Ustaw parametr includeGridData na wartość „true” (prawda). Jeśli ustawisz maskę pola, parametr includeGridData zostanie zignorowany.

W przypadku dużych arkuszy kalkulacyjnych zalecamy pobieranie tylko tych pól, które są Ci 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, którego dotyczy prośba.

Treść żądania

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

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

object (DataFilter)

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ść Prawda, jeśli tabele mają być wykluczone w zakresach zgrupowanych. Fałsz, jeśli nie jest ustawiony.

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 dotyczącym autoryzacji.