Method: spreadsheets.values.batchUpdateByDataFilter

Legt Werte in einem oder mehreren Bereichen einer Tabelle fest. Der Aufrufer muss die Tabellen-ID, einen valueInputOption und einen oder mehrere 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 Tabelle, die aktualisiert werden soll.

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 die angegebene DataFilter mit mehreren Bereichen übereinstimmt, werden die angegebenen Werte auf alle diese Bereiche angewendet.
includeValuesInResponse

boolean

Bestimmt, ob die Antwort auf die Aktualisierung die Werte der aktualisierten Zellen enthalten soll. Standardmäßig enthalten Antworten keine aktualisierten Werte. Das Feld updatedData in jedem BatchUpdateValuesResponse.responses enthält die aktualisierten Werte. Wenn der zu schreibende Bereich größer als der tatsächlich geschriebene Bereich war, enthält die Antwort alle Werte im angeforderten Bereich (ohne leere Zeilen und Spalten am Ende).
responseValueRenderOption

enum (ValueRenderOption)

Bestimmt, wie Werte in der Antwort gerendert werden sollen. Die Standard-Rendering-Option ist FORMATTED_VALUE.
responseDateTimeRenderOption

enum (DateTimeRenderOption)

Bestimmt, wie Datumsangaben, Uhrzeiten und Zeiträume in der Antwort dargestellt werden sollen. Dieser Wert wird ignoriert, wenn responseValueRenderOption FORMATTED_VALUE ist. Die Standardoption für die dateTime-Darstellung ist SERIAL_NUMBER.

Antworttext

Die Antwort beim Aktualisieren eines Wertebereichs in einer Tabelle.

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 Änderungen angewendet wurden.
totalUpdatedRows

integer

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

integer

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

integer

Die Gesamtzahl der aktualisierten Zellen.
totalUpdatedSheets

integer

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

object (UpdateValuesByDataFilterResponse)

Die Antwort für jeden Bereich wird 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 Position durch eine DataFilter angegeben wird.

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

object (DataFilter)

Der Datenfilter, der den Speicherort 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 mit dem Datenfilter übereinstimmen, 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 in einer Tabelle durch einen Datenfilter 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-Notation), auf den die Aktualisierungen angewendet wurden.
updatedRows

integer

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

integer

Die Anzahl der Spalten, in denen mindestens eine Zelle 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 im Bereich, die mit dem Datenfilter übereinstimmen, nachdem alle Aktualisierungen angewendet wurden. Dieser Wert wird nur eingefügt, wenn das Feld includeValuesInResponse der Anfrage true war.