Zwraca arkusz kalkulacyjny o podanym identyfikatorze. Element wywołujący musi określić identyfikator arkusza kalkulacyjnego.
Różni się ona od arkuszy kalkulacyjnych.get tym, że umożliwia wybór podzbiorów danych z arkusza kalkulacyjnego do zwrócenia przez określenie parametru dataFilters
. Można określić więcej niż 1 element DataFilters
. Określenie co najmniej jednego filtra danych powoduje zwrócenie tych części arkusza, które przecinają zakresy zgodne z dowolnym filtrem.
Domyślnie dane w siatkach nie są zwracane. Dane siatki możesz dołączyć na 2 sposoby:
Określ maskę pola z listą potrzebnych pól, używając parametru URL
fields
w HTTPUstaw wartość parametru
includeGridData
na true. Jeśli jest ustawiona maska pola, parametrincludeGridData
jest ignorowany
W przypadku dużych arkuszy kalkulacyjnych zgodnie ze sprawdzonymi metodami pobierz tylko wybrane pola.
Żądanie HTTP
POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:getByDataFilter
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
spreadsheetId |
Arkusz kalkulacyjny, o którego chcesz poprosić. |
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{
"dataFilters": [
{
object ( |
Pola | |
---|---|
dataFilters[] |
Pole |
includeGridData |
Prawda, jeśli powinny zostać zwrócone dane siatki. Ten parametr jest ignorowany, jeśli w żądaniu ustawiono maskę pola. |
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.