REST Resource: forms

Ressource: Formular

Ein Google Formulare-Dokument Ein Formular wird in Google Drive erstellt und dann gelöscht oder über die Drive API gelöscht.

JSON-Darstellung
{
  "formId": string,
  "info": {
    object (Info)
  },
  "settings": {
    object (FormSettings)
  },
  "items": [
    {
      object (Item)
    }
  ],
  "revisionId": string,
  "responderUri": string,
  "linkedSheetId": string
}
Felder
formId

string

Nur Ausgabe. Die Formular-ID.

info

object (Info)

Erforderlich. Der Titel und die Beschreibung des Formulars.

settings

object (FormSettings)

Formulareinstellungen Muss mit UpdateSettingsRequest aktualisiert werden; wird während forms.create und UpdateFormInfoRequest ignoriert.

items[]

object (Item)

Erforderlich. Eine Liste der Elemente des Formulars, die Abschnittsüberschriften, Fragen, eingebettete Medien usw. enthalten kann.

revisionId

string

Nur Ausgabe. Die Überarbeitungs-ID des Formulars. Wird in WriteControl in Aktualisierungsanfragen verwendet, um die Überarbeitung zu identifizieren, auf der die Änderungen basieren.

Das Format der Überarbeitungs-ID kann sich im Laufe der Zeit ändern, deshalb sollte es mit undurchsichtig behandelt werden. Eine zurückgegebene Überarbeitungs-ID ist nach der Rückgabe 24 Stunden lang gültig und kann nicht mit anderen Nutzern geteilt werden. Wenn die Überarbeitungs-ID zwischen Aufrufen unverändert bleibt, bleibt das Formular unverändert. Umgekehrt bedeutet eine geänderte ID für dasselbe Formular und denselben Nutzer in der Regel, dass das Formular aktualisiert wurde. Eine geänderte ID kann aber auch durch interne Faktoren wie Änderungen des ID-Formats verursacht werden.

responderUri

string

Nur Ausgabe. Der Formular-URI, der für Teilnehmer freigegeben werden soll. Daraufhin wird eine Seite geöffnet, auf der Nutzer Antworten senden, aber keine Fragen bearbeiten können.

linkedSheetId

string

Nur Ausgabe. Die ID der verknüpften Google-Tabelle, in der Antworten aus diesem Formular erfasst werden, falls eine solche Tabelle vorhanden ist.

Info

Die allgemeinen Informationen für ein Formular.

JSON-Darstellung
{
  "title": string,
  "documentTitle": string,
  "description": string
}
Felder
title

string

Erforderlich. Der Titel des Formulars, der für die Teilnehmer sichtbar ist.

documentTitle

string

Nur Ausgabe. Der Titel des Dokuments, das in Google Drive sichtbar ist. Wenn Info.title leer ist, kann an der Stelle in der Benutzeroberfläche von Google Formulare documentTitle angezeigt und für die Teilnehmer sichtbar sein. documentTitle kann beim Erstellen festgelegt, aber nicht durch eine BatchUpdate-Anfrage geändert werden. Verwenden Sie die Google Drive API, wenn Sie documentTitle programmatisch aktualisieren müssen.

description

string

Die Beschreibung des Formulars.

Formulareinstellungen

Die Einstellungen eines Formulars.

JSON-Darstellung
{
  "quizSettings": {
    object (QuizSettings)
  }
}
Felder
quizSettings

object (QuizSettings)

Einstellungen für Quizformulare und Benotung.

Quizeinstellungen

Einstellungen für Quizformulare und Benotung. Sie müssen mit „UpdateSettingsRequest“ aktualisiert werden.

JSON-Darstellung
{
  "isQuiz": boolean
}
Felder
isQuiz

boolean

Ob dieses Formular ein Quiz ist oder nicht. Bei „true“ werden Antworten auf Grundlage der Frage Grading benotet. Wenn Sie den Wert auf „false“ setzen, wird die Frage Grading gelöscht.

Element

Ein einzelnes Element des Formulars. kind definiert, um welche Art von Element es sich handelt.

JSON-Darstellung
{
  "itemId": string,
  "title": string,
  "description": string,

  // Union field kind can be only one of the following:
  "questionItem": {
    object (QuestionItem)
  },
  "questionGroupItem": {
    object (QuestionGroupItem)
  },
  "pageBreakItem": {
    object (PageBreakItem)
  },
  "textItem": {
    object (TextItem)
  },
  "imageItem": {
    object (ImageItem)
  },
  "videoItem": {
    object (VideoItem)
  }
  // End of list of possible types for union field kind.
}
Felder
itemId

string

Artikel-ID.

Beim Erstellen kann die ID angegeben werden, aber die ID darf noch nicht im Formular verwendet werden. Wenn nicht angegeben, wird eine neue ID zugewiesen.

title

string

Der Titel des Artikels.

description

string

Die Beschreibung des Artikels.

Union-Feld kind. Erforderlich. Dies ist die Art des Elements. kind kann nur eine der folgenden Optionen sein:
questionItem

object (QuestionItem)

Dem Nutzer wird eine Frage gestellt.

questionGroupItem

object (QuestionGroupItem)

Dem Nutzer wird eine wichtige Frage gestellt.

pageBreakItem

object (PageBreakItem)

Öffnet eine neue Seite mit einem Titel.

textItem

object (TextItem)

Titel und Beschreibung der Seite anzeigen

imageItem

object (ImageItem)

Zeigt ein Bild auf der Seite an.

videoItem

object (VideoItem)

Zeigt ein Video auf der Seite an.

Frage

Ein Formularelement, das eine einzelne Frage enthält.

JSON-Darstellung
{
  "question": {
    object (Question)
  },
  "image": {
    object (Image)
  }
}
Felder
question

object (Question)

Erforderlich. Die angezeigte Frage.

image

object (Image)

Bild, das in der Frage angezeigt wird

Frage

Fragen. Der Fragetyp ist der kind bekannt.

JSON-Darstellung
{
  "questionId": string,
  "required": boolean,
  "grading": {
    object (Grading)
  },

  // Union field kind can be only one of the following:
  "choiceQuestion": {
    object (ChoiceQuestion)
  },
  "textQuestion": {
    object (TextQuestion)
  },
  "scaleQuestion": {
    object (ScaleQuestion)
  },
  "dateQuestion": {
    object (DateQuestion)
  },
  "timeQuestion": {
    object (TimeQuestion)
  },
  "fileUploadQuestion": {
    object (FileUploadQuestion)
  },
  "rowQuestion": {
    object (RowQuestion)
  }
  // End of list of possible types for union field kind.
}
Felder
questionId

string

Schreibgeschützt. Die ID der Frage.

Beim Erstellen kann die ID angegeben werden, aber die ID darf noch nicht im Formular verwendet werden. Wenn nicht angegeben, wird eine neue ID zugewiesen.

required

boolean

Gibt an, ob die Frage beantwortet werden muss, damit der Teilnehmer seine Antwort senden kann.

grading

object (Grading)

Einrichtung der Benotung für die Frage

Union-Feld kind. Erforderlich. Die Art der Frage, die einem Teilnehmer angeboten wird. Für kind ist nur einer der folgenden Werte zulässig:
choiceQuestion

object (ChoiceQuestion)

Der Teilnehmer hat die Wahl zwischen vordefinierten Optionen.

textQuestion

object (TextQuestion)

Teilnehmer können eine Freitextantwort eingeben.

scaleQuestion

object (ScaleQuestion)

Der Teilnehmer kann eine Zahl aus einem Bereich auswählen.

dateQuestion

object (DateQuestion)

Ein Teilnehmer kann ein Datum eingeben.

timeQuestion

object (TimeQuestion)

Ein Teilnehmer kann eine Uhrzeit eingeben.

fileUploadQuestion

object (FileUploadQuestion)

Ein Teilnehmer kann eine oder mehrere Dateien hochladen.

rowQuestion

object (RowQuestion)

Eine Zeile mit einer QuestionGroupItem.

Auswahlfrage

Eine Frage zu einem Radio/Kästchen/Drop-down-Menü

JSON-Darstellung
{
  "type": enum (ChoiceType),
  "options": [
    {
      object (Option)
    }
  ],
  "shuffle": boolean
}
Felder
type

enum (ChoiceType)

Erforderlich. Die Art der Auswahlfrage.

options[]

object (Option)

Erforderlich. Liste der Optionen, aus denen ein Teilnehmer auswählen muss.

shuffle

boolean

Gibt an, ob die Optionen für verschiedene Instanzen des Quiz in zufälliger Reihenfolge angezeigt werden sollen. Damit wird häufig verhindert, dass Betrüger beleidigt werden, die auf den Bildschirm eines anderen Teilnehmers blicken, oder um Verzerrungen in einer Umfrage zu beseitigen, die durch das direkte Bewerten derselben Optionen entstehen.

Auswahltyp

Die Art der Wahl.

Enums
CHOICE_TYPE_UNSPECIFIED Standardwert nicht in Verwendung.
RADIO Optionsfelder: Dem Nutzer werden alle Optionen angezeigt, die nur eine davon auswählen können.
CHECKBOX Kästchen: Alle Optionen werden dem Nutzer angezeigt, der eine beliebige Anzahl davon auswählen kann.
DROP_DOWN Drop-down-Menü: Die Optionen werden dem Nutzer nur bei Bedarf angezeigt, andernfalls wird nur die aktuelle Auswahl angezeigt. Es kann nur eine Option ausgewählt werden.

Option

Option für eine Choice-Frage.

JSON-Darstellung
{
  "value": string,
  "image": {
    object (Image)
  },
  "isOther": boolean,

  // Union field go_to_section can be only one of the following:
  "goToAction": enum (GoToAction),
  "goToSectionId": string
  // End of list of possible types for union field go_to_section.
}
Felder
value

string

Erforderlich. Die Auswahl, die dem Nutzer präsentiert wird.

image

object (Image)

Bild als Option anzeigen.

isOther

boolean

Gibt an, ob die Option „Sonstiges“ ist. Gilt derzeit nur für die Auswahltypen RADIO und CHECKBOX, ist aber in QuestionGroupItem nicht zulässig.

Union-Feld go_to_section. Welcher Abschnitt aufzurufen ist, wenn diese Option ausgewählt ist? Gilt derzeit nur für den Auswahltyp RADIO und SELECT, ist aber in QuestionGroupItem nicht zulässig. go_to_section kann nur einer der folgenden Werte sein:
goToAction

enum (GoToAction)

Typ der Abschnittsnavigation.

goToSectionId

string

Element-ID der Abschnittsüberschrift, zu der er weitergeleitet werden soll.

Zur Aktion

Konstanten für die Abschnittsnavigation

Enums
GO_TO_ACTION_UNSPECIFIED Standardwert nicht in Verwendung.
NEXT_SECTION Gehen Sie zum nächsten Abschnitt.
RESTART_FORM Zurück zum Anfang des Formulars.
SUBMIT_FORM Formular sofort senden.

Bild

Daten, die ein Bild darstellen.

JSON-Darstellung
{
  "contentUri": string,
  "altText": string,
  "properties": {
    object (MediaProperties)
  },

  // Union field image_source can be only one of the following:
  "sourceUri": string
  // End of list of possible types for union field image_source.
}
Felder
contentUri

string

Nur Ausgabe. Ein URI, von dem Sie das Bild herunterladen können. Dieser ist nur für begrenzte Zeit gültig.

altText

string

Eine Beschreibung des Bildes, das von Screenreadern angezeigt wird, wenn der Mauszeiger darauf bewegt wird.

properties

object (MediaProperties)

Eigenschaften eines Bilds.

Union-Feld image_source. Die Art der Bildquelle. Beim Erstellen neuer Bilder muss genau ein Bildquellenfeld festgelegt werden. Für image_source ist nur einer der folgenden Werte zulässig:
sourceUri

string

Nur Eingabe. Der Quell-URI ist der URI zum Einfügen des Bildes. Der Quell-URI kann beim Abrufen leer sein.

Medieneigenschaften

Eigenschaften der Medien.

JSON-Darstellung
{
  "alignment": enum (Alignment),
  "width": integer
}
Felder
alignment

enum (Alignment)

Position des Mediums.

width

integer

Breite des Mediums in Pixeln Wenn das Medium angezeigt wird, wird es auf den kleineren Wert oder die Breite des angezeigten Formulars skaliert. Das ursprüngliche Seitenverhältnis des Medien bleibt erhalten. Wenn beim Hinzufügen des Mediums keine Breite angegeben ist, wird die Breite der Medienquelle festgelegt. Die Breite muss zwischen 0 und 740 liegen. Das Festlegen einer Breite auf „0“ oder nicht angegeben ist nur beim Aktualisieren der Medienquelle zulässig.

Ausrichtung

Ausrichtung auf der Seite.

Enums
ALIGNMENT_UNSPECIFIED Standardwert nicht in Verwendung.
LEFT Linksbündig ausrichten.
RIGHT Rechtsbündig
CENTER Mitte.

Frage

Eine textbasierte Frage.

JSON-Darstellung
{
  "paragraph": boolean
}
Felder
paragraph

boolean

Gibt an, ob die Frage ein Absatz ist. Wenn nicht, ist die Frage eine kurze Frage.

Frage zur Skala

Eine Frage zum Thema Skala. Der Nutzer kann aus einem Bereich numerischer Werte auswählen.

JSON-Darstellung
{
  "low": integer,
  "high": integer,
  "lowLabel": string,
  "highLabel": string
}
Felder
low

integer

Erforderlich. Der niedrigste mögliche Wert für die Skala.

high

integer

Erforderlich. Der höchstmögliche Wert für die Waage.

lowLabel

string

Das anzuzeigende Label, das den niedrigsten Punkt auf der Skala beschreibt.

highLabel

string

Das anzuzeigende Label, das den höchsten Punkt auf der Skala beschreibt.

Datumsfrage

Eine Frage zum Datum. Fragen zum Datum werden standardmäßig nur auf Monat und Tag gestellt.

JSON-Darstellung
{
  "includeTime": boolean,
  "includeYear": boolean
}
Felder
includeTime

boolean

Gibt an, ob die Zeit als Teil der Frage verwendet werden soll.

includeYear

boolean

Gibt an, ob das Jahr bei der Frage berücksichtigt werden soll.

Zeitfrage

Eine Zeitfrage.

JSON-Darstellung
{
  "duration": boolean
}
Felder
duration

boolean

true, wenn sich die Frage auf eine verstrichene Zeit bezieht. Ansonsten ist es eine Tageszeit.

Frage zum Dateiupload

Eine Frage zum Hochladen von Dateien: Das Erstellen von Fragen für den Datei-Upload wird in der API derzeit nicht unterstützt.

JSON-Darstellung
{
  "folderId": string,
  "types": [
    enum (FileType)
  ],
  "maxFiles": integer,
  "maxFileSize": string
}
Felder
folderId

string

Erforderlich. Die ID des Google Drive-Ordners, in dem hochgeladene Dateien gespeichert sind.

types[]

enum (FileType)

Von dieser Frage akzeptierte Dateitypen.

maxFiles

integer

Maximale Anzahl von Dateien, die für diese Frage in einer einzelnen Antwort hochgeladen werden können.

maxFileSize

string (int64 format)

Maximal zulässige Anzahl von Byte für jede einzelne Datei, die in diese Frage hochgeladen wird.

Dateityp

Dateitypen, die für eine Frage hochgeladen werden können.

Enums
FILE_TYPE_UNSPECIFIED Standardwert nicht in Verwendung.
ANY Keine Einschränkungen für den Typ.
DOCUMENT Ein Google Docs-Dokument
PRESENTATION Eine Google-Präsentation
SPREADSHEET Eine Tabelle in Google Tabellen.
DRAWING Eine Zeichnung
PDF Eine PDF.
IMAGE Ein Bild.
VIDEO ein Video
AUDIO Eine Audiodatei

Zeilenfrage

Konfiguration für eine Frage, die Teil einer Fragengruppe ist.

JSON-Darstellung
{
  "title": string
}
Felder
title

string

Erforderlich. Der Titel für die einzelne Zeile in QuestionGroupItem.

Benotung

Benotung einer einzelnen Frage

JSON-Darstellung
{
  "pointValue": integer,
  "correctAnswers": {
    object (CorrectAnswers)
  },
  "whenRight": {
    object (Feedback)
  },
  "whenWrong": {
    object (Feedback)
  },
  "generalFeedback": {
    object (Feedback)
  }
}
Felder
pointValue

integer

Erforderlich. Die maximale Anzahl von Punkten, die ein Teilnehmer automatisch für eine richtige Antwort erhalten kann. Dieser Wert darf nicht negativ sein.

correctAnswers

object (CorrectAnswers)

Erforderlich. Der Antwortschlüssel für die Frage. Die Antworten werden anhand dieses Feldes automatisch benotet.

whenRight

object (Feedback)

Das Feedback für richtige Antworten. Dieses Feedback kann nur für Multiple-Choice-Fragen mit den richtigen Antworten festgelegt werden.

whenWrong

object (Feedback)

Das Feedback, das für falsche Antworten angezeigt wird. Dieses Feedback kann nur für Multiple-Choice-Fragen mit den richtigen Antworten festgelegt werden.

generalFeedback

object (Feedback)

Das Feedback, das für alle Antworten angezeigt wird. Dies wird häufig bei Kurzantwort-Fragen verwendet, wenn der Inhaber des Quiz den Teilnehmern schnell zeigen möchte, ob er die Frage richtig beantwortet hat, bevor er die Antwort offiziell bewerten konnte. Für automatisch benotete Multiple-Choice-Fragen kann kein allgemeines Feedback festgelegt werden.

Richtige Antworten

Der Antwortschlüssel für eine Frage.

JSON-Darstellung
{
  "answers": [
    {
      object (CorrectAnswer)
    }
  ]
}
Felder
answers[]

object (CorrectAnswer)

Eine Liste mit den richtigen Antworten. Eine Quizantwort kann automatisch benotet werden. Bei Fragen mit einem Wert wird eine Antwort als richtig markiert, wenn sie mit einem Wert in dieser Liste übereinstimmt (d. h., es sind mehrere richtige Antworten möglich). Bei Fragen mit mehreren Werten (CHECKBOX) wird eine Antwort als korrekt markiert, wenn sie genau die Werte in dieser Liste enthält.

Richtige Antwort

Eine einzige richtige Antwort auf eine Frage. Bei Fragen mit mehreren Werten (CHECKBOX) sind möglicherweise mehrere CorrectAnswer erforderlich, um eine einzelne richtige Antwortoption zu repräsentieren.

JSON-Darstellung
{
  "value": string
}
Felder
value

string

Erforderlich. Der richtige Antwortwert. Weitere Informationen zur Formatierung verschiedener Werttypen finden Sie in der Dokumentation zu TextAnswer.value.

QuestionGroupItem

Definiert eine Frage, die mehrere Fragen umfasst, die in Gruppen zusammengefasst sind.

JSON-Darstellung
{
  "questions": [
    {
      object (Question)
    }
  ],
  "image": {
    object (Image)
  },

  // Union field kind can be only one of the following:
  "grid": {
    object (Grid)
  }
  // End of list of possible types for union field kind.
}
Felder
questions[]

object (Question)

Erforderlich. Eine Liste mit Fragen, die zu dieser Fragegruppe gehören. Eine Frage darf nur zu einer Gruppe gehören. Die kind der Gruppe beeinflusst, welche Fragen zulässig sind.

image

object (Image)

Bild, das in der Fragengruppe über den jeweiligen Fragen angezeigt wird

Union-Feld kind. Erforderlich. Die Art der Fragengruppe, die bestimmt, welche Fragetypen zulässig sind und wie sie angezeigt werden. Für kind ist nur einer der folgenden Werte zulässig:
grid

object (Grid)

Die Fragengruppe ist ein Raster mit Zeilen mit Multiple-Choice-Fragen mit denselben Optionen. Wenn grid festgelegt ist, müssen alle Fragen in der Gruppe den Typ row haben.

Raster

Ein Raster mit Auswahlmöglichkeiten (Radio oder Kästchen) und jede Zeile, die eine separate Frage darstellt. Für jede Zeile gelten dieselben Optionen, die auch als Spalten angezeigt werden.

JSON-Darstellung
{
  "columns": {
    object (ChoiceQuestion)
  },
  "shuffleQuestions": boolean
}
Felder
columns

object (ChoiceQuestion)

Erforderlich. Die Auswahl, die bei jeder Frage im Raster geteilt wird. Das heißt, die Werte der Spalten. Es sind nur CHECK_BOX und RADIO Optionen zulässig.

shuffleQuestions

boolean

Wenn true, werden die Fragen nach dem Zufallsprinzip sortiert. Die Zeilen werden also für jeden Teilnehmer in einer anderen Reihenfolge angezeigt.

Seitenumbruch

Seitenumbruch Der Titel und die Beschreibung dieses Artikels werden oben auf der neuen Seite angezeigt.

Textelement

Ein Textelement.

Bildelement

Ein Element mit einem Bild.

JSON-Darstellung
{
  "image": {
    object (Image)
  }
}
Felder
image

object (Image)

Erforderlich. Das im Artikel angezeigte Bild

Videoartikel

Ein Element mit einem Video.

JSON-Darstellung
{
  "video": {
    object (Video)
  },
  "caption": string
}
Felder
video

object (Video)

Erforderlich. Das im Artikel angezeigte Video

caption

string

Der Text, der unter dem Video angezeigt wird.

Video

Daten, die ein Video darstellen.

JSON-Darstellung
{
  "youtubeUri": string,
  "properties": {
    object (MediaProperties)
  }
}
Felder
youtubeUri

string

Erforderlich. Ein YouTube-URI.

properties

object (MediaProperties)

Eigenschaften eines Videos.

Methoden

batchUpdate

Das Formular mit mehreren Aktualisierungen ändern

create

Erstellen Sie ein neues Formular mit dem in der Anfrage angegebenen Titel.

get

Formular erstellen