Method: spreadsheets.values.batchUpdateByDataFilter

Legt Werte in einem oder mehreren Bereichen einer Tabelle fest. Der Aufrufer muss die Tabellen-ID, eine valueInputOption und mindestens eine DataFilterValueRanges angeben.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
spreadsheetId

string

Die ID der zu aktualisierenden Tabelle.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "valueInputOption": enum (ValueInputOption),
  "data": [
    {
      object (DataFilterValueRange)
    }
  ],
  "includeValuesInResponse": boolean,
  "responseValueRenderOption": enum (ValueRenderOption),
  "responseDateTimeRenderOption": enum (DateTimeRenderOption)
}
Felder
valueInputOption

enum (ValueInputOption)

Wie die Eingabedaten interpretiert werden sollen.
data[]

object (DataFilterValueRange)

Die neuen Werte, die auf die Tabelle angewendet werden sollen. Wenn mehr als ein Bereich mit dem angegebenen DataFilter übereinstimmt, werden die angegebenen Werte auf alle diese Bereiche angewendet.
includeValuesInResponse

boolean

Bestimmt, ob die Aktualisierungsantwort die Werte der aktualisierten Zellen enthalten soll. Standardmäßig enthalten die Antworten nicht die aktualisierten Werte. Das Feld updatedData in jeder BatchUpdateValuesResponse.responses enthält die aktualisierten Werte. Wenn der zu schreibende Bereich größer war als der tatsächlich geschriebene Bereich, enthält die Antwort alle Werte im angeforderten Bereich, mit Ausnahme der nachgestellten leeren Zeilen und Spalten.
responseValueRenderOption

enum (ValueRenderOption)

Bestimmt, wie Werte in der Antwort gerendert werden sollen. Die Standardeinstellung für das Rendering ist FORMATTED_VALUE.
responseDateTimeRenderOption

enum (DateTimeRenderOption)

Legt fest, wie Datum, Uhrzeit und Dauer in der Antwort gerendert werden sollen. Dies wird ignoriert, wenn responseValueRenderOption den Wert FORMATTED_VALUE hat. Die standardmäßige Renderingoption für „dateTime“ ist SERIAL_NUMBER.

Antworttext

Die Antwort, wenn ein Wertebereich in einer Tabelle aktualisiert wird.

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

JSON-Darstellung 
{
  "spreadsheetId": string,
  "totalUpdatedRows": integer,
  "totalUpdatedColumns": integer,
  "totalUpdatedCells": integer,
  "totalUpdatedSheets": integer,
  "responses": [
    {
      object (UpdateValuesByDataFilterResponse)
    }
  ]
}
Felder
spreadsheetId

string

Die Tabelle, auf die die Aktualisierungen angewendet wurden.
totalUpdatedRows

integer

Die Gesamtzahl der Zeilen, bei denen mindestens eine Zelle in der Zeile aktualisiert wurde.
totalUpdatedColumns

integer

Die Gesamtzahl der Spalten, in denen mindestens eine Zelle in der Spalte aktualisiert wurde.
totalUpdatedCells

integer

Die Gesamtzahl der aktualisierten Zellen.
totalUpdatedSheets

integer

Die Gesamtzahl der Tabellenblätter, in denen mindestens eine Zelle des Tabellenblatts aktualisiert wurde.
responses[]

object (UpdateValuesByDataFilterResponse)

Die Antwort wurde für jeden Bereich aktualisiert.

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.

DataFilterValueRange

Ein Wertebereich, dessen Standort durch DataFilter angegeben wird.

JSON-Darstellung 
{
  "dataFilter": {
    object (DataFilter)
  },
  "majorDimension": enum (Dimension),
  "values": [
    array
  ]
}
Felder
dataFilter

object (DataFilter)

Der Datenfilter, der die Position der Werte in der Tabelle beschreibt.
majorDimension

enum (Dimension)

Die Hauptdimension der Werte.
values[]

array (ListValue format)

Die zu schreibenden Daten. Wenn die angegebenen Werte einen der Bereiche überschreiten, die dem Datenfilter entsprechen, schlägt die Anfrage fehl. Wenn die angegebenen Werte kleiner als die übereinstimmenden Bereiche sind, werden nur die angegebenen Werte geschrieben. Vorhandene Werte in den übereinstimmenden Bereichen bleiben davon unberührt.

UpdateValuesByDataFilterResponse

Die Antwort, wenn ein Wertebereich mit einem Datenfilter in einer Tabelle aktualisiert wird.

JSON-Darstellung 
{
  "updatedRange": string,
  "updatedRows": integer,
  "updatedColumns": integer,
  "updatedCells": integer,
  "dataFilter": {
    object (DataFilter)
  },
  "updatedData": {
    object (ValueRange)
  }
}
Felder
updatedRange

string

Der Bereich (in A1-Schreibweise), auf den Aktualisierungen angewendet wurden.
updatedRows

integer

Die Anzahl der Zeilen, in denen mindestens eine Zelle in der Zeile aktualisiert wurde.
updatedColumns

integer

Die Anzahl der Spalten, in denen mindestens eine Zelle der Spalte aktualisiert wurde.
updatedCells

integer

Die Anzahl der aktualisierten Zellen.
dataFilter

object (DataFilter)

Der Datenfilter, mit dem der aktualisierte Bereich ausgewählt wurde.
updatedData

object (ValueRange)

Die Werte der Zellen in dem Bereich, die mit dem dataFilter übereinstimmen, nachdem alle Aktualisierungen angewendet wurden. Dies ist nur enthalten, wenn das Feld includeValuesInResponse der Anfrage true war.