Method: spreadsheets.values.batchGetByDataFilter

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

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, mit denen die abzurufenden Wertebereiche abgeglichen werden. Bereiche, die mit einem der angegebenen Datenfilter übereinstimmen, sind in der Antwort enthalten.
majorDimension

enum (Dimension)

Die Hauptdimension, die für die Ergebnisse verwendet werden soll.

Wenn die Tabellendaten beispielsweise A1=1,B1=2,A2=3,B2=4 sind, gibt eine Anfrage, die diesen Bereich auswählt und majorDimension=ROWS festlegt, [[1,2],[3,4]] zurück. Eine Anfrage, die majorDimension=COLUMNS festlegt, gibt dagegen [[1,3],[2,4]] zurück.
valueRenderOption

enum (ValueRenderOption)

Gibt an, wie Werte in der Ausgabe dargestellt werden sollen. Die Standard-Rendering-Option ist FORMATTED_VALUE.
dateTimeRenderOption

enum (DateTimeRenderOption)

Gibt an, wie Datum, Uhrzeit und Dauer in der Ausgabe dargestellt werden sollen. Dieser Wert wird ignoriert, wenn valueRenderOption FORMATTED_VALUE ist. Die Standardoption für die dateTime-Darstellung ist SERIAL_NUMBER.

Antworttext

Die Antwort beim Abrufen mehrerer Wertebereiche in einer Tabelle, die mit DataFilters ausgewählt wurden.

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 mit der Liste der Datenfilter, die mit ihnen übereinstimmen.

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.

MatchedValueRange

Ein Wertebereich, der mit einem oder mehreren Datenfiltern übereinstimmt.

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

object (ValueRange)

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

object (DataFilter)

Der DataFilters aus der Anfrage, der mit dem Wertebereich übereinstimmt.