Method: forms.batchUpdate

Ändern Sie das Formular mit einer Reihe von Aktualisierungen.

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 eine aktualisierte Version des Modells in der Antwort zurückgegeben werden soll.
requests[]

object (Request)

Erforderlich. Die Aktualisierungsanfragen dieses Batches.
writeControl

object (WriteControl)

Bietet Kontrolle darüber, 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)

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

object (Response)

Die Antwort auf die Aktualisierungen. Dies entspricht 1:1 den Aktualisierungsanfragen, 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/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 der 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)

Formularinformationen aktualisieren.
updateSettings

object (UpdateSettingsRequest)

Aktualisiert die Formulareinstellungen.
createItem

object (CreateItemRequest)

Neues Element erstellen.
moveItem

object (MoveItemRequest)

Verschiebt ein Element an einen bestimmten Ort.
deleteItem

object (DeleteItemRequest)

Element löschen
updateItem

object (UpdateItemRequest)

Aktualisieren Sie ein Element.

UpdateFormInfoRequest

Formularinformationen aktualisieren.

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. Die Stamm-info ist impliziert und sollte nicht angegeben werden. Mit nur einer "*" können Sie schnell alle Felder aktualisieren.

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

UpdateSettingsRequest

FormSettings des Formulars aktualisieren.

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. Die Stamm-settings ist impliziert und sollte nicht angegeben werden. Mit nur einer "*" können Sie schnell alle Felder aktualisieren.

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 soll das neue Element platziert werden?

Standort

Eine bestimmte Stelle 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 Speicherort an. Für where ist nur einer der folgenden Werte zulässig:
index

integer

Der Index eines Elements im Formular. Dieser Wert muss im Bereich

[0..N)

, wobei N die Anzahl der Elemente im Formular ist.

MoveItemRequest

Element in einem Formular verschieben

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

object (Location)

Erforderlich. Die Position des zu verschiebenden Elements.
newLocation

object (Location)

Erforderlich. Der neue Speicherort des Elements.

DeleteItemRequest

Element in einem Formular löschen

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

object (Location)

Erforderlich. Der Speicherort des zu löschenden Elements.

UpdateItemRequest

Aktualisieren Sie ein Element in einem Formular.

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

object (Item)

Erforderlich. Neue Werte für das Element. Hinweis: Element- und Frage-IDs werden verwendet, wenn sie angegeben sind und sich in der Feldmaske befinden. Wenn eine ID leer ist und in der Feldmaske enthalten ist, wird eine neue ID generiert. Das bedeutet, dass Sie ein Element ändern können, indem Sie das Formular über forms.get abrufen, Ihre lokale Kopie des Elements nach Bedarf ändern und UpdateItemRequest zum Zurückschreiben verwenden, wobei die IDs identisch sind (oder nicht in der Feldmaske).
location

object (Location)

Erforderlich. Der Ort, an dem das zu aktualisierende Element identifiziert wird.
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

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 Formulars, von der aus Änderungen angewendet werden sollen, und das Verhalten der Anfrage, wenn die Überarbeitung nicht die aktuelle Version des Formulars ist. Für control ist nur einer der folgenden Werte zulässig:
requiredRevisionId

string

Die Überarbeitungs-ID des Formulars, auf das die Schreibanfrage angewendet wird. Ist dies nicht die letzte Version des Formulars, wird die Anfrage nicht verarbeitet und der Fehler „400 Bad Request“ wird zurückgegeben.
targetRevisionId

string

Die Zielversions-ID des Formulars, auf das die Schreibanfrage angewendet wird.

Wenn nach dieser Überarbeitung Änderungen aufgetreten sind, werden die Änderungen in dieser Aktualisierungsanfrage auf diese Änderungen angewendet. Dies führt zu einer neuen Überarbeitung des Formulars, die sowohl die Änderungen in der Anfrage als auch die dazwischen liegenden Änderungen enthält, wobei der Server widersprüchliche Änderungen behebt.

Die Zielversions-ID kann nur zum Schreiben in aktuelle Versionen eines Formulars verwendet werden. Wenn die Zielversion zu weit hinter der letzten Version zurückliegt, wird die Anfrage nicht verarbeitet und der Fehler 400 (Fehler wegen falscher Anfrage) wird zurückgegeben. Nachdem Sie die neueste Version des Formulars gelesen haben, kann es noch einmal versucht werden, die Anfrage zu senden. In den meisten Fällen bleibt eine Zielversions-ID nach dem Lesen noch mehrere Minuten gültig. Bei häufig bearbeiteten Formularen kann dieses Fenster jedoch kürzer sein.

Antwort

Eine einzelne Antwort auf eine Aktualisierung.

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 der Erstellung eines Elements.

CreateItemResponse

Das Ergebnis der Erstellung eines Elements.

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

string

Die ID des erstellten Elements.
questionId[]

string

Die ID der Frage, die als Teil dieses Elements erstellt wurde. Für eine Fragengruppe werden IDs aller Fragen aufgeführt, die für dieses Element erstellt wurden.