Method: spreadsheets.batchUpdate

Wendet ein oder mehrere Updates auf die Tabelle an.

Jede request wird vor der Anwendung validiert. Wenn eine Anfrage ungültig ist, schlägt die gesamte Anfrage fehl und es wird nichts angewendet.

Einige Anfragen haben replies, um Ihnen Informationen zur Anwendung zu geben. Die Antworten spiegeln die Anfragen wider. Wenn Sie beispielsweise vier Updates angewendet haben und das dritte eine Antwort hatte, enthält die Antwort zwei leere Antworten, die tatsächliche Antwort und eine weitere leere Antwort in dieser Reihenfolge.

Da Tabellenkalkulationen von mehreren Nutzern bearbeitet werden können, ist nicht garantiert, dass die Tabelle nach Abschluss des Vorgangs genau Ihre Änderungen widerspiegelt. Es ist jedoch garantiert, dass die Aktualisierungen in der Anfrage atomar angewendet werden. Ihre Änderungen können sich in Bezug auf Änderungen von Mitbearbeitern ändern. Wenn es keine Mitbearbeiter gibt, sollten die Änderungen in der Tabelle angezeigt werden.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
spreadsheetId

string

Die Tabelle, auf die die Aktualisierungen angewendet werden sollen.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "requests": [
    {
      object (Request)
    }
  ],
  "includeSpreadsheetInResponse": boolean,
  "responseRanges": [
    string
  ],
  "responseIncludeGridData": boolean,
  "commentsViewMode": enum (CommentsViewMode)
}
Felder
requests[]

object (Request)

Eine Liste der Aktualisierungen, die auf die Tabelle angewendet werden sollen. Anfragen werden in der angegebenen Reihenfolge angewendet. Wenn eine Anfrage ungültig ist, werden keine Anfragen angewendet.

includeSpreadsheetInResponse

boolean

Gibt an, ob die Tabellenressource in die Antwort auf die Aktualisierung aufgenommen werden soll.

responseRanges[]

string

Beschränkt die Bereiche, die in der Antworttabelle enthalten sind. Nur relevant, wenn includeSpreadsheetInResponse „true“ ist.

responseIncludeGridData

boolean

„True“, wenn Rasterdaten zurückgegeben werden sollen. Nur relevant, wenn includeSpreadsheetInResponse „true“ ist. Dieser Parameter wird ignoriert, wenn in der Anfrage eine Feldmaske festgelegt wurde.

commentsViewMode

enum (CommentsViewMode)

Der Ansichtsmodus für Kommentare, der auf die Tabelle angewendet werden soll. So können Sie die Tabelle mit oder ohne Kommentare aufrufen. Wenn keine angegeben ist, wird COMMENTS_VIEW_MODE_OMITTED verwendet. Nur relevant, wenn includeSpreadsheetInResponse „true“ ist.

Antworttext

Die Antwort für das Batch-Aktualisieren einer Tabelle.

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

JSON-Darstellung
{
  "spreadsheetId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "updatedSpreadsheet": {
    object (Spreadsheet)
  },
  "commentUpdateState": enum (CommentUpdateState)
}
Felder
spreadsheetId

string

Die Tabelle, auf die die Aktualisierungen angewendet wurden.

replies[]

object (Response)

Die Antwort auf die Updates. Dies entspricht 1:1 den Updates, obwohl Antworten auf einige Anfragen leer sein können.

updatedSpreadsheet

object (Spreadsheet)

Die Tabelle, nachdem die Änderungen angewendet wurden. Wird nur festgelegt, wenn BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response true ist.

commentUpdateState

enum (CommentUpdateState)

Gibt an, ob Kommentaraktualisierungen in der Batchanfrage angewendet wurden.

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

CommentUpdateState

Der Status von Kommentaraktualisierungen in der Batchanfrage.

Enums
COMMENT_UPDATE_STATE_UNSPECIFIED Der Status von Kommentaraktualisierungen ist nicht angegeben.
NO_UPDATES_REQUESTED In der Batchanfrage wurden keine Kommentaraktualisierungen angefordert.
ALL_SAVED Alle angeforderten Kommentaraktualisierungen wurden in der Batchanfrage angewendet.
ALL_FAILED_UNKNOWN_REASON Alle angeforderten Kommentaraktualisierungen sind fehlgeschlagen.