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żesz podać wiele wartości DataFilters. Określenie co najmniej 1 filtra danych powoduje zwrócenie części arkusza kalkulacyjnego, 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 sprawdzoną metodą jest pobieranie tylko tych pól arkusza, 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,
  "commentsViewMode": enum (CommentsViewMode)
}
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ść „prawda”, jeśli tabele mają być wykluczone z zakresów pasmowych. Wartość „Fałsz”, jeśli nie jest ustawiona.
commentsViewMode

enum (CommentsViewMode)

Tryb wyświetlania komentarzy, który ma być zastosowany w arkuszu kalkulacyjnym. Dzięki temu możesz wyświetlać arkusz kalkulacyjny z pominiętymi lub uwzględnionymi komentarzami. Jeśli nie zostanie określony, użyta zostanie wartość COMMENTS_VIEW_MODE_OMITTED.

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.