Method: forms.batchUpdate

Ändern Sie das Formular mit mehreren Updates.

HTTP-Anfrage

POST https://forms.googleapis.com/v1/forms/{formId}:batchUpdate

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
formId

string

Erforderlich. Die Formular-ID.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

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

boolean

Gibt an, ob in der Antwort eine aktualisierte Version des Modells zurückgegeben werden soll.
requests[]

object (Request)

Erforderlich. Die Aktualisierungsanfragen dieses Batches.
writeControl

object (WriteControl)

Steuert, wie Schreibanfragen ausgeführt werden.

Antworttext

Antwort auf eine BatchUpdateFormRequest.

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

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

object (Form)

Je nach dem booleschen Anfragefeld includeFormInResponse wird ein Formular mit allen angewendeten Mutationen/Aktualisierungen zurückgegeben oder nicht. Diese kann später sein als die durch diese Änderungen erstellte Revision-ID.
replies[]

object (Response)

Die Antwort auf die Aktualisierungen. Die Zuordnung erfolgt 1:1 mit den Aktualisierungsanfragen, auch wenn die Antworten auf einige Anfragen leer sein können.
writeControl

object (WriteControl)

Die aktualisierte Schreibsteuerung nach dem Anwenden der Anfrage.

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/forms.body

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

Anfrage

Die Arten von Aktualisierungsanfragen, die gestellt werden können.

JSON-Darstellung 
{

  // Union field kind can be only one of the following:
  "updateFormInfo": {
    object (UpdateFormInfoRequest)
  },
  "updateSettings": {
    object (UpdateSettingsRequest)
  },
  "createItem": {
    object (CreateItemRequest)
  },
  "moveItem": {
    object (MoveItemRequest)
  },
  "deleteItem": {
    object (DeleteItemRequest)
  },
  "updateItem": {
    object (UpdateItemRequest)
  }
  // End of list of possible types for union field kind.
}
Felder
Union-Feld kind. Die Art der Anfrage. Für kind ist nur einer der folgenden Werte zulässig:
updateFormInfo

object (UpdateFormInfoRequest)

Aktualisieren Sie die Informationen im Formular.
updateSettings

object (UpdateSettingsRequest)

Aktualisiert die Einstellungen des Formulars.
createItem

object (CreateItemRequest)

Neues Element erstellen.
moveItem

object (MoveItemRequest)

Elemente an einen bestimmten Ort verschieben
deleteItem

object (DeleteItemRequest)

Löschen Sie einen Artikel.
updateItem

object (UpdateItemRequest)

Artikel aktualisieren

UpdateFormInfoRequest

Aktualisieren Sie die Informationen im Formular.

JSON-Darstellung 
{
  "info": {
    object (Info)
  },
  "updateMask": string
}
Felder
info

object (Info)

Die zu aktualisierenden Informationen.
updateMask

string (FieldMask format)

Erforderlich. Es werden nur die in dieser Maske genannten Werte geändert. Es muss mindestens ein Feld angegeben werden. Der Stamm info ist implizit und sollte nicht angegeben werden. Eine einzelne "*" kann als Kurzschreibweise für die Aktualisierung aller Felder verwendet werden.

Dies ist eine durch Kommas getrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".

UpdateSettingsRequest

Aktualisieren Sie das FormSettings des Formulars.

JSON-Darstellung 
{
  "settings": {
    object (FormSettings)
  },
  "updateMask": string
}
Felder
settings

object (FormSettings)

Erforderlich. Die Einstellungen, die aktualisiert werden sollen.
updateMask

string (FieldMask format)

Erforderlich. Es werden nur die in dieser Maske genannten Werte geändert. Es muss mindestens ein Feld angegeben werden. Der Stamm settings ist implizit und sollte nicht angegeben werden. Eine einzelne "*" kann als Kurzschreibweise für die Aktualisierung aller Felder verwendet werden.

Dies ist eine durch Kommas getrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".

CreateItemRequest

Erstellen Sie ein Element in einem Formular.

JSON-Darstellung 
{
  "item": {
    object (Item)
  },
  "location": {
    object (Location)
  }
}
Felder
item

object (Item)

Erforderlich. Das zu erstellende Element.
location

object (Location)

Erforderlich. Wo das neue Element platziert werden soll.

Standort

Ein bestimmter Ort in einem Formular.

JSON-Darstellung 
{

  // Union field where can be only one of the following:
  "index": integer
  // End of list of possible types for union field where.
}
Felder
Union-Feld where Erforderlich. Geben Sie im Formular einen Standort an. Für where ist nur einer der folgenden Werte zulässig:
index

integer

Der Index eines Elements im Formular. Er muss im Bereich

[0..N)

wobei N die Anzahl der Elemente im Formular ist.

MoveItemRequest

Ein Element in einem Formular verschieben

JSON-Darstellung 
{
  "originalLocation": {
    object (Location)
  },
  "newLocation": {
    object (Location)
  }
}
Felder
originalLocation

object (Location)

Erforderlich. Der Speicherort des Artikels, der verschoben werden soll.
newLocation

object (Location)

Erforderlich. Der neue Speicherort des Artikels.

DeleteItemRequest

Elemente in einem Formular löschen

JSON-Darstellung 
{
  "location": {
    object (Location)
  }
}
Felder
location

object (Location)

Erforderlich. Der Speicherort des zu löschenden Elements.

UpdateItemRequest

Element in einem Formular aktualisieren

JSON-Darstellung 
{
  "item": {
    object (Item)
  },
  "location": {
    object (Location)
  },
  "updateMask": string
}
Felder
item

object (Item)

Erforderlich. Neue Werte für das Element. Artikel- und Frage-IDs werden verwendet, wenn sie angegeben sind (und in der Feldmaske enthalten sind). Wenn eine ID leer ist (und sich in der Feldmaske befindet), wird eine neue ID generiert. Das bedeutet, dass Sie ein Element ändern können, indem Sie das Formular über forms.get abrufen, die lokale Kopie dieses Elements nach Ihren Wünschen ändern und es mit UpdateItemRequest zurückschreiben. Die IDs müssen dabei gleich sein (oder nicht in der Feldmaske enthalten).
location

object (Location)

Erforderlich. Der Standort, der den zu aktualisierenden Artikel identifiziert.
updateMask

string (FieldMask format)

Erforderlich. Es werden nur die in dieser Maske genannten Werte geändert.

Dies ist eine durch Kommas getrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".

WriteControl

Steuert, 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 Version des Formulars, aus der Änderungen übernommen werden sollen, und wie sich die Anfrage verhalten soll, wenn diese Version nicht die aktuelle Version des Formulars ist. Für control ist nur einer der folgenden Werte zulässig:
requiredRevisionId

string

Die Versions-ID des Formulars, auf das die Schreibanfrage angewendet wird. Wenn dies nicht die neueste Version des Formulars ist, wird die Anfrage nicht verarbeitet und es wird der Fehler 400 zurückgegeben.
targetRevisionId

string

Die Zielüberarbeitungs-ID des Formulars, auf das die Schreibanfrage angewendet wird.

Wenn nach dieser Überarbeitung Änderungen vorgenommen wurden, werden die Änderungen in diesem Aktualisierungsantrag an diese Änderungen angepasst. Dies führt zu einer neuen Version des Formulars, die sowohl die Änderungen in der Anfrage als auch die zwischenzeitlich vorgenommenen Änderungen enthält. Der Server löst dabei in Konflikt stehende Änderungen.

Die Zielüberarbeitungs-ID kann nur zum Schreiben in die neuesten Versionen eines Formulars verwendet werden. Wenn die Zielversion zu weit hinter der neuesten Version liegt, wird die Anfrage nicht verarbeitet und es wird der Fehler 400 (Fehlerhafte Anfrage) zurückgegeben. Die Anfrage kann nach dem Lesen der aktuellen Version des Formulars noch einmal versucht werden. In den meisten Fällen bleibt eine Zielversions-ID nach dem Lesen mehrere Minuten lang gültig. Bei häufig bearbeiteten Formularen kann dieser Zeitraum jedoch kürzer sein.

Antwort

Eine einzelne Antwort von einem Update.

JSON-Darstellung 
{

  // Union field kind can be only one of the following:
  "createItem": {
    object (CreateItemResponse)
  }
  // End of list of possible types for union field kind.
}
Felder
Union-Feld kind. Die Art der Antwort. Für kind ist nur einer der folgenden Werte zulässig:
createItem

object (CreateItemResponse)

Das Ergebnis des Erstellens eines Elements.

CreateItemResponse

Das Ergebnis des Erstellens eines Elements.

JSON-Darstellung 
{
  "itemId": string,
  "questionId": [
    string
  ]
}
Felder
itemId

string

Die ID des erstellten Elements.
questionId[]

string

Die ID der Frage, die im Rahmen dieses Elements erstellt wurde. Bei einer Fragengruppe werden die IDs aller für dieses Element erstellten Fragen aufgeführt.