Method: spreadsheets.values.batchGetByDataFilter

Zwraca co najmniej 1 zakres wartości pasujących do określonych filtrów danych. Więcej informacji znajdziesz w artykule Odczytywanie, zapisywanie i wyszukiwanie metadanych.

Wywołujący musi podać identyfikator arkusza kalkulacyjnego i co najmniej 1 DataFilters. Zostaną zwrócone zakresy, które pasują do dowolnego z filtrów danych w żądaniu.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
spreadsheetId

string

Identyfikator arkusza kalkulacyjnego, z którego mają być pobierane dane.

Treść żądania

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

Zapis JSON
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "majorDimension": enum (Dimension),
  "valueRenderOption": enum (ValueRenderOption),
  "dateTimeRenderOption": enum (DateTimeRenderOption)
}
Pola
dataFilters[]

object (DataFilter)

Filtry danych używane do dopasowywania zakresów wartości do pobrania. Odpowiedź zawiera zakresy, które pasują do dowolnego z określonych filtrów danych.

majorDimension

enum (Dimension)

Główny wymiar, którego powinny używać wyniki.

Jeśli na przykład dane w arkuszu kalkulacyjnym to A1=1,B1=2,A2=3,B2=4, żądanie, które wybiera ten zakres i ustawia majorDimension=ROWS, zwraca [[1,2],[3,4]], a żądanie, które ustawia majorDimension=COLUMNS, zwraca [[1,3],[2,4]].

valueRenderOption

enum (ValueRenderOption)

Sposób reprezentowania wartości w danych wyjściowych. Domyślna opcja renderowania to FORMATTED_VALUE.

dateTimeRenderOption

enum (DateTimeRenderOption)

Jak daty, godziny i okresy powinny być przedstawiane w danych wyjściowych. Jest to ignorowane, jeśli valueRenderOption ma wartość FORMATTED_VALUE. Domyślna opcja renderowania daty i godziny to SERIAL_NUMBER.

Treść odpowiedzi

Odpowiedź podczas pobierania więcej niż jednego zakresu wartości w arkuszu kalkulacyjnym wybranym przez DataFilters.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "spreadsheetId": string,
  "valueRanges": [
    {
      object (MatchedValueRange)
    }
  ]
}
Pola
spreadsheetId

string

Identyfikator arkusza kalkulacyjnego, z którego pobrano dane.

valueRanges[]

object (MatchedValueRange)

Żądane wartości wraz z listą pasujących do nich filtrów danych.

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.

MatchedValueRange

Zakres wartości, który został dopasowany przez co najmniej 1 filtr danych.

Zapis JSON
{
  "valueRange": {
    object (ValueRange)
  },
  "dataFilters": [
    {
      object (DataFilter)
    }
  ]
}
Pola
valueRange

object (ValueRange)

Wartości dopasowane przez element DataFilter.

dataFilters[]

object (DataFilter)

Wartość DataFilters z żądania, która pasuje do zakresu wartości.