Method: spreadsheets.values.batchGetByDataFilter

Gibt einen oder mehrere Wertebereiche zurück, die den angegebenen Datenfiltern entsprechen. Der Aufrufer muss die Tabellen-ID und mindestens eine 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 einem der angegebenen Datenfilter entsprechen, sind in der Antwort enthalten.
majorDimension

enum (Dimension)

Die Hauptdimension, die in den Ergebnissen verwendet werden soll.

Wenn die Tabellendaten beispielsweise A1=1,B1=2,A2=3,B2=4 lauten, gibt eine Anfrage, mit der dieser Bereich ausgewählt und majorDimension=ROWS festgelegt wird, [[1,2],[3,4]] zurück. Eine Anfrage, die majorDimension=COLUMNS festlegt, gibt hingegen [[1,3],[2,4]] zurück.
valueRenderOption

enum (ValueRenderOption)

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

enum (DateTimeRenderOption)

Wie Datum, Uhrzeit und Dauer in der Ausgabe dargestellt werden sollen. Dies wird ignoriert, wenn valueRenderOption den Wert FORMATTED_VALUE hat. Die standardmäßige Renderingoption für „dateTime“ ist SERIAL_NUMBER.

Antworttext

Die Antwort, wenn mehr als ein Wertebereich in einer von DataFilters ausgewählten Tabelle abgerufen wird.

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 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.

MatchedValueRange

Ein Wertebereich, dem mindestens ein Datenfiler zugeordnet wurde.

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

object (ValueRange)

Die mit DataFilter übereinstimmenden Werte.
dataFilters[]

object (DataFilter)

Die DataFilters aus der Anfrage, die mit dem Wertebereich übereinstimmte.