Method: spreadsheets.values.batchGetByDataFilter

Gibt einen oder mehrere Wertebereiche zurück, die den angegebenen Datenfiltern entsprechen. Der Anrufer muss die Tabellen-ID und mindestens eine DataFilters angeben. Bereiche, die mit einem der Datenfilter in der Anfrage übereinstimmen, werden zurückgegeben.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
spreadsheetId

string

Die ID der Tabelle, aus der Daten abgerufen werden sollen.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

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

object (DataFilter)

Die Datenfilter, die verwendet werden, um die Wertebereiche abzurufen, die abgerufen werden sollen. In der Antwort sind Bereiche enthalten, die mit einem der angegebenen Datenfilter übereinstimmen.
majorDimension

enum (Dimension)

Die wichtigste Dimension, die mit den Ergebnissen verwendet werden soll.

Wenn die Tabellendaten beispielsweise A1=1,B1=2,A2=3,B2=4 lauten, wird für eine Anfrage, mit der dieser Bereich ausgewählt und majorDimension=ROWS festgelegt wird, [[1,2],[3,4]] zurückgegeben, während eine Anfrage, bei der majorDimension=COLUMNS festgelegt wird, [[1,3],[2,4]] zurückgibt.
valueRenderOption

enum (ValueRenderOption)

Wie Werte in der Ausgabe dargestellt werden sollen. Die Standardoption für das Rendering ist FORMATTED_VALUE.
dateTimeRenderOption

enum (DateTimeRenderOption)

Wie Datum, Uhrzeit und Dauer in der Ausgabe dargestellt werden sollen. Diese wird ignoriert, wenn valueRenderOption den Wert FORMATTED_VALUE hat. Die standardmäßige Rendering-Option „dateTime“ ist SERIAL_NUMBER.

Antworttext

Die Antwort beim Abrufen mehrerer Wertebereiche in einer von DataFilters ausgewählten Tabelle.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "spreadsheetId": string,
  "valueRanges": [
    {
      object (MatchedValueRange)
    }
  ]
}
Felder
spreadsheetId

string

Die ID der Tabelle, aus der die Daten abgerufen wurden.
valueRanges[]

object (MatchedValueRange)

Die angeforderten Werte wurden mit einer Liste von Datenfiltern abgeglichen, die ihnen entsprechen.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

Wertebereich

Ein Wertebereich, der von einem oder mehreren Datenfiltern abgeglichen wurde.

JSON-Darstellung 
{
  "valueRange": {
    object (ValueRange)
  },
  "dataFilters": [
    {
      object (DataFilter)
    }
  ]
}
Felder
valueRange

object (ValueRange)

Die Werte, die mit DataFilter übereinstimmen.
dataFilters[]

object (DataFilter)

Die DataFilters aus der Anfrage, die dem Wertebereich entspricht.