Method: documents.batchUpdate

Wendet mindestens eine Aktualisierung auf das Dokument 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.

Für einige Anfragen sind replies erforderlich, um Informationen zu ihrer Anwendung zu erhalten. Bei anderen Anfragen müssen keine Informationen zurückgegeben werden. geben beide eine leere Antwort zurück. Die Reihenfolge der Antworten entspricht der Reihenfolge der Anfragen.

Angenommen, Sie rufen BatchUpdate mit vier Aktualisierungen auf und nur die dritte gibt Informationen zurück. Die Antwort würde zwei leere Antworten enthalten, die Antwort auf die dritte Anfrage und eine weitere leere Antwort in dieser Reihenfolge.

Da das Dokument möglicherweise von anderen Nutzern bearbeitet wird, spiegelt das Dokument Ihre Änderungen möglicherweise nicht genau wider: Ihre Änderungen werden möglicherweise im Hinblick auf die Änderungen der Mitbearbeiter angepasst. Wenn es keine Mitbearbeiter gibt, sollten Ihre Änderungen im Dokument zu sehen sein. In jedem Fall werden die Aktualisierungen in Ihrer Anfrage garantiert gemeinsam atomar angewendet.

HTTP-Anfrage

POST https://docs.googleapis.com/v1/documents/{documentId}:batchUpdate

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
documentId

string

Die ID des Dokuments, das aktualisiert werden soll.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Felder
requests[]

object (Request)

Eine Liste der Aktualisierungen, die auf das Dokument angewendet werden sollen.
writeControl

object (WriteControl)

Bietet Kontrolle darüber, wie Schreibanfragen ausgeführt werden.

Antworttext

Antwortnachricht von einer documents.batchUpdate-Anfrage.

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

JSON-Darstellung 
{
  "documentId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Felder
documentId

string

Die ID des Dokuments, auf das die Aktualisierungen angewendet wurden.
replies[]

object (Response)

Die Antwort auf die Aktualisierungen. Dies entspricht 1:1 den Aktualisierungen, auch wenn auf einige Anfragen möglicherweise leer ist.
writeControl

object (WriteControl)

Das aktualisierte Schreibsteuerelement nach dem Anwenden der Anfrage.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/documents
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

WriteControl

Bietet Kontrolle darüber, wie Schreibanfragen ausgeführt werden.

JSON-Darstellung 
{

  // Union field control can be only one of the following:
  "requiredRevisionId": string,
  "targetRevisionId": string
  // End of list of possible types for union field control.
}
Felder
Union-Feld control. Bestimmt die Überarbeitung des Dokuments, in die geschrieben werden soll, und das Verhalten der Anfrage, wenn es sich bei dieser Überarbeitung nicht um die aktuelle Überarbeitung des Dokuments handelt. Wenn keines der beiden Felder angegeben ist, werden die Aktualisierungen auf die neueste Version angewendet. Für control ist nur einer der folgenden Werte zulässig:
requiredRevisionId

string

Der optionale revision ID des Dokuments, auf das die Schreibanfrage angewendet wird. Ist dies nicht die letzte Version des Dokuments, wird die Anfrage nicht verarbeitet und es wird der Fehler „400 Bad Request“ zurückgegeben.

Wenn eine erforderliche Überarbeitungs-ID in einer Antwort zurückgegeben wird, gibt sie die Überarbeitungs-ID des Dokuments an, nachdem die Anfrage angewendet wurde.
targetRevisionId

string

Das optionale Ziel revision ID des Dokuments, auf das die Schreibanfrage angewendet wird.

Wenn Änderungen von Mitbearbeitern vorgenommen wurden, nachdem das Dokument mithilfe der API gelesen wurde, werden die durch diese Schreibanfrage erzeugten Änderungen auf die Änderungen der Mitbearbeiter angewendet. Dies führt zu einer neuen Version des Dokuments, die sowohl die Änderungen der Mitbearbeiter als auch die Änderungen in der Anfrage enthält, wobei der Google Docs-Server die Änderungskonflikte behebt. Bei Verwendung der Zielversions-ID kann der API-Client als weiterer Mitbearbeiter des Dokuments betrachtet werden.

Die Zielversions-ID kann nur zum Schreiben in aktuelle Versionen eines Dokuments verwendet werden. Wenn die Zielversion zu weit hinter der letzten Version zurückliegt, wird die Anfrage nicht verarbeitet und der Fehler 400 für fehlerhafte Anfrage zurückgegeben. Die Anfrage sollte nach dem Abrufen der neuesten Version des Dokuments noch einmal versucht werden. Normalerweise bleibt eine Überarbeitungs-ID nach dem Lesen mehrere Minuten lang gültig und kann als Zielversion verwendet werden. Bei häufig bearbeiteten Dokumenten kann dieses Fenster jedoch kürzer sein.