- HTTP-Anfrage
- Pfadparameter
- Anfragetext
- Antworttext
- Autorisierungsbereiche
- Anfrage
- UpdateFormInfoRequest
- UpdateSettingsRequest
- CreateItemRequest
- Standort
- MoveItemRequest
- DeleteItemRequest
- UpdateItemRequest
- WriteControl
- Antwort
- CreateItemResponse
- Testen!
Das Formular mit mehreren Aktualisierungen ändern
HTTP-Anfrage
POST https://forms.googleapis.com/v1/forms/{formId}:batchUpdate
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter | |
---|---|
formId |
Erforderlich. Die Formular-ID. |
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
JSON-Darstellung |
---|
{ "includeFormInResponse": boolean, "requests": [ { object ( |
Felder | |
---|---|
includeFormInResponse |
Gibt an, ob eine aktualisierte Version des Modells in der Antwort zurückgegeben werden soll. |
requests[] |
Erforderlich. Die Aktualisierungsanfragen für diesen Batch. |
writeControl |
Hiermit wird gesteuert, wie Schreibanfragen ausgeführt werden. |
Antworttext
Antwort auf eine BatchUpdateFormRequest-Anfrage.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
JSON-Darstellung |
---|
{ "form": { object ( |
Felder | |
---|---|
form |
Basierend auf dem booleschen Anfragefeld „ |
replies[] |
Die Antwort zu den Updates. Dies wird 1:1 den Aktualisierungsanfragen zugeordnet, wobei Antworten auf einige Anfragen möglicherweise leer sind. |
writeControl |
Das aktualisierte Schreibsteuerelement nach Anwendung 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.
Anfragen
Welche Arten von Aktualisierungsanfragen möglich sind
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld kind . Die Art der Anfrage. Für kind ist nur einer der folgenden Werte zulässig: |
|
updateFormInfo |
Aktualisieren Sie die Formularinformationen. |
updateSettings |
Aktualisiert die Einstellungen des Formulars. |
createItem |
Neues Element erstellen. |
moveItem |
Element an einen bestimmten Speicherort verschieben |
deleteItem |
Ein Element löschen |
updateItem |
Ein Element aktualisieren. |
UpdateFormInfoRequest
Aktualisieren Sie die Formularinformationen.
JSON-Darstellung |
---|
{
"info": {
object ( |
Felder | |
---|---|
info |
Informationen, die aktualisiert werden sollen. |
updateMask |
Erforderlich. Nur in dieser Maske benannte Werte werden geändert. Es muss mindestens ein Feld angegeben werden. Das Stammverzeichnis Dies ist eine durch Kommas getrennte Liste vollständig qualifizierter Namen von Feldern. Beispiel: |
UpdateSettingsRequest
FormSettings
des Formulars aktualisieren.
JSON-Darstellung |
---|
{
"settings": {
object ( |
Felder | |
---|---|
settings |
Erforderlich. Die Einstellungen, die aktualisiert werden sollen. |
updateMask |
Erforderlich. Nur in dieser Maske benannte Werte werden geändert. Es muss mindestens ein Feld angegeben werden. Das Stammverzeichnis Dies ist eine durch Kommas getrennte Liste vollständig qualifizierter Namen von Feldern. Beispiel: |
Anfrage erstellen
Elemente in einem Formular erstellen
JSON-Darstellung |
---|
{ "item": { object ( |
Felder | |
---|---|
item |
Erforderlich. Das zu erstellende Element |
location |
Erforderlich. Platzieren Sie den neuen Artikel. |
Location
Ein bestimmter Ort in einem Formular.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld where Erforderlich. Geben Sie einen Standort im Formular an. Für where ist nur einer der folgenden Werte zulässig: |
|
index |
Der Index eines Elements im Formular. Der Wert muss im Bereich liegen
, wobei N die Anzahl der Elemente im Formular ist. |
Anfrage verschieben
Elemente in Formulare verschieben
JSON-Darstellung |
---|
{ "originalLocation": { object ( |
Felder | |
---|---|
originalLocation |
Erforderlich. Der Speicherort des zu verschiebenden Elements. |
newLocation |
Erforderlich. Der neue Speicherort für den Artikel. |
Anfrage löschen
Elemente in einem Formular löschen
JSON-Darstellung |
---|
{
"location": {
object ( |
Felder | |
---|---|
location |
Erforderlich. Der Speicherort des zu löschenden Elements. |
UpdateItemRequest
Elemente in einem Formular aktualisieren
JSON-Darstellung |
---|
{ "item": { object ( |
Felder | |
---|---|
item |
Erforderlich. Neue Werte für das Element. Artikel- und Frage-IDs werden verwendet, wenn sie angegeben wurden und sich in der Feldmaske befinden. Wenn eine ID leer ist und sich in der Feldmaske befindet, wird eine neue ID generiert. Du kannst ein Element also ändern, indem du das Formular über |
location |
Erforderlich. Der Standort, der das zu aktualisierende Element identifiziert. |
updateMask |
Erforderlich. Nur in dieser Maske benannte Werte werden geändert. Dies ist eine durch Kommas getrennte Liste vollständig qualifizierter Namen von Feldern. Beispiel: |
Schreibsteuerung
Hiermit wird gesteuert, wie Schreibanfragen ausgeführt werden.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld control . Bestimmt die Überarbeitung des Formulars, auf die die Änderungen angewendet werden sollen, und wie sich die Anfrage verhält, wenn diese Überarbeitung nicht die aktuelle Überarbeitung des Formulars ist. Für control ist nur einer der folgenden Werte zulässig: |
|
requiredRevisionId |
Die Überarbeitungs-ID des Formulars, auf das die Schreibanfrage angewendet wird. Falls es sich nicht um die letzte Überarbeitung des Formulars handelt, wird die Anfrage nicht verarbeitet und der Fehler 400 wird zurückgegeben. |
targetRevisionId |
Die Zielüberarbeitungs-ID des Formulars, auf das die Schreibanfrage angewendet wird. Wenn nach dieser Überarbeitung Änderungen vorgenommen wurden, werden die Änderungen in dieser Aktualisierungsanfrage mit diesen Änderungen umgewandelt. Das führt zu einer neuen Überarbeitung des Formulars, in der sowohl die Änderungen in der Anfrage als auch die dazwischenliegenden Änderungen berücksichtigt werden, wobei der Server widersprüchliche Änderungen löst. Die Zielüberarbeitungs-ID kann nur zum Schreiben in aktuelle Versionen eines Formulars verwendet werden. Wenn die Zielüberarbeitung zu weit hinter der letzten Überarbeitung zurückliegt, wird die Anfrage nicht verarbeitet und ein 400-Fehler (Fehlerhafte Anfrage) zurückgegeben. Die Anfrage kann wiederholt werden, nachdem die aktuelle Version des Formulars gelesen wurde. In den meisten Fällen bleibt die Zielüberarbeitungs-ID einige Minuten nach dem Lesen gültig. Bei häufig bearbeiteten Formularen kann es jedoch kürzer sein. |
Antwort
Eine einzelne Antwort von einem Update.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld kind . Die Art der Antwort. Für kind ist nur einer der folgenden Werte zulässig: |
|
createItem |
Das Ergebnis des Erstellens eines Elements. |
Antwort Antwort erstellen
Das Ergebnis des Erstellens eines Elements.
JSON-Darstellung |
---|
{ "itemId": string, "questionId": [ string ] } |
Felder | |
---|---|
itemId |
Die ID des erstellten Elements. |
questionId[] |
Die ID der Frage, die als Teil dieses Artikels erstellt wurde. Bei einer Fragengruppe werden die IDs aller für dieses Element erstellten Fragen aufgelistet. |