Zwraca arkusz kalkulacyjny o podanym identyfikatorze. Wywołujący musi podać identyfikator arkusza kalkulacyjnego.
Ta metoda różni się od videos.get tym, że pozwala wybierać podzbiory danych z arkusza kalkulacyjnego do zwrócenia przez określenie parametru dataFilters
. Można określić kilka wartości DataFilters
. Po określeniu co najmniej jednego filtra danych zwracają one te części arkusza kalkulacyjnego, 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ą odpowiednich pól, korzystając z parametru adresu URL
fields
w protokole HTTP.Ustaw wartość parametru
includeGridData
na „true”. Jeśli ustawiona jest maska pola, parametrincludeGridData
jest ignorowany.
Sprawdzoną metodą w przypadku dużych arkuszy kalkulacyjnych jest pobieranie tylko tych pól, których potrzebujesz.
Żą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, którego dotyczy prośba. |
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{
"dataFilters": [
{
object ( |
Pola | |
---|---|
dataFilters[] |
Element |
includeGridData |
Prawda, jeśli dane siatki mają być zwracane. 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 protokołu 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 na temat autoryzacji.