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 mit einem der angegebenen Datenfilter übereinstimmen, werden in die Antwort aufgenommen.

majorDimension

enum (Dimension)

Die Hauptdimension, die in den Ergebnissen 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, während eine Anfrage, die majorDimension=COLUMNS festlegt, [[1,3],[2,4]].

valueRenderOption

enum (ValueRenderOption)

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

dateTimeRenderOption

enum (DateTimeRenderOption)

Gibt an, wie Datum, Uhrzeit und Dauer in der Ausgabe dargestellt werden sollen. Dies wird ignoriert, wenn valueRenderOption FORMATTED_VALUE ist. Die standardmäßige Renderingoption für dateTime ist SERIAL_NUMBER.

Antworttext

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

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender 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

Wertebereich, der von einem oder mehreren Datenfilern abgeglichen wurde.

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

object (ValueRange)

Die Werte, die der DataFilter entsprechen.

dataFilters[]

object (DataFilter)

Die DataFilters aus der Anfrage, die dem Wertebereich entspricht.