- Ressource: Formular
- Info
- FormSettings
- QuizSettings
- EmailCollectionType
- Artikel
- QuestionItem
- Frage
- ChoiceQuestion
- ChoiceType
- Option
- GoToAction
- Bilder
- MediaProperties
- Ausrichtung
- TextQuestion
- ScaleQuestion
- DateQuestion
- TimeQuestion
- FileUploadQuestion
- FileType
- RowQuestion
- RatingQuestion
- RatingIconType
- Benotung
- CorrectAnswers
- CorrectAnswer
- QuestionGroupItem
- Raster
- PageBreakItem
- TextItem
- ImageItem
- VideoItem
- Videos
- PublishSettings
- PublishState
- Methoden
Ressource: Formular
Ein Google-Formulardokument. Formulare werden in Drive erstellt. Das Löschen eines Formulars oder das Ändern der Zugriffsschutzmaßnahmen erfolgt über die Drive API.
JSON-Darstellung |
---|
{ "formId": string, "info": { object ( |
Felder | |
---|---|
formId |
Nur Ausgabe. Die Formular-ID. |
info |
Erforderlich. Titel und Beschreibung des Formulars. |
settings |
Die Einstellungen des Formulars. Dieser Wert muss mit |
items[] |
Erforderlich. Eine Liste der Elemente des Formulars, z. B. Abschnittsüberschriften, Fragen und eingebettete Medien. |
revisionId |
Nur Ausgabe. Die Überarbeitungs-ID des Formulars. Wird in Aktualisierungsanfragen im Das Format der Revision-ID kann sich im Laufe der Zeit ändern. Daher sollte sie nicht transparent behandelt werden. Eine zurückgegebene Versions-ID ist nur 24 Stunden nach der Rückgabe gültig und kann nicht für mehrere Nutzer verwendet werden. Wenn sich die Revision-ID zwischen den Aufrufen nicht ändert, hat sich der Inhalt des Formulars nicht geändert. Umgekehrt bedeutet eine geänderte ID (für dasselbe Formular und denselben Nutzer) in der Regel, dass der Inhalt des Formulars aktualisiert wurde. Eine geänderte ID kann jedoch auch auf interne Faktoren wie Änderungen am ID-Format zurückzuführen sein. Der Formularinhalt schließt Formularmetadaten aus, darunter:
|
responderUri |
Nur Ausgabe. Die Formular-URI, die für Teilnehmer freigegeben werden soll. Daraufhin wird eine Seite geöffnet, auf der Nutzer Antworten einreichen, aber die Fragen nicht bearbeiten können. Bei Formularen, für die der Wert |
linkedSheetId |
Nur Ausgabe. Die ID der verknüpften Google-Tabelle, in der die Antworten aus diesem Formular erfasst werden (falls eine solche Tabelle vorhanden ist). |
publishSettings |
Nur Ausgabe. Die Veröffentlichungseinstellungen für ein Formular. Dieses Feld ist für alte Formulare nicht festgelegt, da sie das Feld Für Formulare mit festgelegtem |
Info
Die allgemeinen Informationen zu einem Formular.
JSON-Darstellung |
---|
{ "title": string, "documentTitle": string, "description": string } |
Felder | |
---|---|
title |
Erforderlich. Der Titel des Formulars, der für die Teilnehmer sichtbar ist. |
documentTitle |
Nur Ausgabe. Der Titel des Dokuments, der in Drive angezeigt wird. Wenn |
description |
Die Beschreibung des Formulars. |
FormSettings
Einstellungen eines Formulars.
JSON-Darstellung |
---|
{ "quizSettings": { object ( |
Felder | |
---|---|
quizSettings |
Einstellungen für Quizformulare und die Benotung. |
emailCollectionType |
Optional. Hier legen Sie fest, ob im Formular E-Mail-Adressen von den Teilnehmern erfasst werden. |
QuizSettings
Einstellungen für Quizformulare und die Benotung. Diese müssen mit der UpdateSettingsRequest aktualisiert werden.
JSON-Darstellung |
---|
{ "isQuiz": boolean } |
Felder | |
---|---|
isQuiz |
Gibt an, ob es sich bei diesem Formular um ein Quiz handelt. Wenn diese Option aktiviert ist, werden die Antworten anhand von Frage |
EmailCollectionType
Optional. Hier legen Sie fest, ob und wie E-Mail-Adressen von den Teilnehmern erfasst werden. Wenn im Formular E-Mail-Adressen erfasst werden, werden die Werte in das Feld formResponse.respondentEmail
eingefügt.
Enums | |
---|---|
EMAIL_COLLECTION_TYPE_UNSPECIFIED |
Nicht angegeben Dieser Wert wird nicht verwendet. |
DO_NOT_COLLECT |
Im Formular werden keine E-Mail-Adressen erfasst. Standardwert, wenn der Eigentümer des Formulars ein Google-Konto verwendet. |
VERIFIED |
Im Formular werden E-Mail-Adressen automatisch basierend auf dem Konto des angemeldeten Nutzers erfasst. Standardwert, wenn der Eigentümer des Formulars ein Google Workspace-Konto verwendet. |
RESPONDER_INPUT |
Im Formular werden E-Mail-Adressen über ein Feld erfasst, das die Teilnehmer im Formular ausfüllen. |
Element
Ein einzelnes Element des Formulars. kind
definiert, um welche Art von Artikel es sich handelt.
JSON-Darstellung |
---|
{ "itemId": string, "title": string, "description": string, // Union field |
Felder | |
---|---|
itemId |
Die Artikel-ID. Sie kann beim Erstellen angegeben werden, darf aber nicht bereits im Formular verwendet werden. Wenn keine ID angegeben wird, wird eine neue ID zugewiesen. |
title |
Der Titel des Artikels. |
description |
Die Beschreibung des Artikels. |
Union-Feld kind . Erforderlich. Die Art des Artikels. Für kind ist nur einer der folgenden Werte zulässig: |
|
questionItem |
Dem Nutzer wird eine Frage gestellt. |
questionGroupItem |
Dem Nutzer werden eine oder mehrere Fragen mit einem einzigen Hauptprompt gestellt. |
pageBreakItem |
Startet eine neue Seite mit einem Titel. |
textItem |
Ein Titel und eine Beschreibung werden auf der Seite angezeigt. |
imageItem |
Zeigt ein Bild auf der Seite an. |
videoItem |
Ein Video wird auf der Seite angezeigt. |
QuestionItem
Ein Formularelement mit einer einzelnen Frage.
JSON-Darstellung |
---|
{ "question": { object ( |
Felder | |
---|---|
question |
Erforderlich. Die angezeigte Frage. |
image |
Das Bild, das in der Frage angezeigt wird. |
Frage
Gibt es Fragen? Die Art der Frage wird durch ihre kind
angegeben.
JSON-Darstellung |
---|
{ "questionId": string, "required": boolean, "grading": { object ( |
Felder | |
---|---|
questionId |
Schreibgeschützt. Die Frage-ID. Sie kann beim Erstellen angegeben werden, darf aber nicht bereits im Formular verwendet werden. Wenn keine ID angegeben wird, wird eine neue ID zugewiesen. |
required |
Ob die Frage beantwortet werden muss, damit ein Teilnehmer seine Antwort einreichen kann. |
grading |
Bewertungseinstellungen für die Frage. |
Union-Feld kind . Erforderlich. Die Art der Frage, die einem Teilnehmer gestellt wird. Für kind ist nur einer der folgenden Werte zulässig: |
|
choiceQuestion |
Die Befragten können aus einer Reihe von vordefinierten Optionen auswählen. |
textQuestion |
Die Teilnehmer können eine Freitextantwort eingeben. |
scaleQuestion |
Die Teilnehmer können eine Zahl aus einem Bereich auswählen. |
dateQuestion |
Ein Teilnehmer kann ein Datum eingeben. |
timeQuestion |
Ein Teilnehmer kann eine Uhrzeit eingeben. |
fileUploadQuestion |
Ein Teilnehmer kann eine oder mehrere Dateien hochladen. |
rowQuestion |
Eine Zeile einer |
ratingQuestion |
Die Befragten können eine Bewertung aus einer vordefinierten Reihe von Symbolen auswählen. |
ChoiceQuestion
Eine Frage mit Optionsfeld, Kästchen oder Drop-down-Menü.
JSON-Darstellung |
---|
{ "type": enum ( |
Felder | |
---|---|
type |
Erforderlich. Der Typ der Auswahlfrage. |
options[] |
Erforderlich. Liste der Optionen, aus denen ein Teilnehmer auswählen muss. |
shuffle |
Ob die Optionen für verschiedene Instanzen des Quiz in zufälliger Reihenfolge angezeigt werden sollen. Dies wird häufig verwendet, um Betrug durch Teilnehmer zu verhindern, die auf den Bildschirm eines anderen Teilnehmers schauen, oder um Verzerrungen in einer Umfrage zu vermeiden, die durch das immer Ersteinfügen oder Letzteinfügen derselben Optionen entstehen können. |
ChoiceType
Die Art der Auswahl.
Enums | |
---|---|
CHOICE_TYPE_UNSPECIFIED |
Standardwert Nicht verwendet |
RADIO |
Optionsfelder: Dem Nutzer werden alle Optionen angezeigt, er kann aber nur eine davon auswählen. |
CHECKBOX |
Kästchen: Alle Optionen werden dem Nutzer angezeigt, der beliebig viele davon auswählen kann. |
DROP_DOWN |
Drop-down-Menü: Die Auswahlmöglichkeiten werden dem Nutzer nur auf Anfrage angezeigt, andernfalls nur die aktuelle Auswahl. Es kann nur eine Option ausgewählt werden. |
Option
Eine Option für eine Auswahlfrage.
JSON-Darstellung |
---|
{ "value": string, "image": { object ( |
Felder | |
---|---|
value |
Erforderlich. Die Auswahl, die dem Nutzer angezeigt wird. |
image |
Bild als Option anzeigen |
isOther |
Ob die Option „Sonstiges“ ist. Gilt derzeit nur für die Auswahltypen |
Union-Feld go_to_section . Der Bereich, der angezeigt wird, wenn diese Option ausgewählt ist. Gilt derzeit nur für den Auswahltyp RADIO und SELECT , ist aber in einem QuestionGroupItem nicht zulässig. Für go_to_section ist nur einer der folgenden Werte zulässig: |
|
goToAction |
Navigationstyp des Abschnitts. |
goToSectionId |
Artikel-ID des Abschnittsheaders, zu dem du wechseln möchtest. |
GoToAction
Konstanten für die Navigation durch Abschnitte.
Enums | |
---|---|
GO_TO_ACTION_UNSPECIFIED |
Standardwert Nicht verwendet |
NEXT_SECTION |
Fahren Sie mit dem nächsten Abschnitt fort. |
RESTART_FORM |
Kehren Sie zum Anfang des Formulars zurück. |
SUBMIT_FORM |
Reichen Sie das Formular sofort ein. |
Bild
Daten, die ein Bild darstellen.
JSON-Darstellung |
---|
{ "contentUri": string, "altText": string, "properties": { object ( |
Felder | |
---|---|
contentUri |
Nur Ausgabe. Ein URI, über den Sie das Bild herunterladen können. Dieser ist nur für eine begrenzte Zeit gültig. |
altText |
Eine Beschreibung des Bildes, die beim Bewegen des Mauszeigers angezeigt und von Screenreadern vorgelesen wird. |
properties |
Eigenschaften eines Bildes. |
Union-Feld image_source . Die Art der Bildquelle. Beim Erstellen neuer Bilder muss genau ein Feld für die Bildquelle festgelegt werden. Für image_source ist nur einer der folgenden Werte zulässig: |
|
sourceUri |
Nur Eingabe. Der Quell-URI ist der URI, mit dem das Bild eingefügt wurde. Der Quell-URI kann beim Abrufen leer sein. |
MediaProperties
Eigenschaften der Medien.
JSON-Darstellung |
---|
{
"alignment": enum ( |
Felder | |
---|---|
alignment |
Position der Medien. |
width |
Die Breite des Mediums in Pixeln. Bei der Anzeige des Mediums wird es auf den kleineren Wert oder die Breite des angezeigten Formulars skaliert. Das ursprüngliche Seitenverhältnis der Medien bleibt erhalten. Wenn beim Hinzufügen von Medien zum Formular keine Breite angegeben wird, wird sie auf die Breite der Medienquelle festgelegt. Die Breite muss zwischen 0 und 740 liegen. Die Breite kann nur beim Aktualisieren der Medienquelle auf „0“ oder „nicht angegeben“ festgelegt werden. |
Ausrichtung
Ausrichtung auf der Seite
Enums | |
---|---|
ALIGNMENT_UNSPECIFIED |
Standardwert Nicht verwendet |
LEFT |
Linksbündig ausrichten. |
RIGHT |
Rechtsbündig ausrichten. |
CENTER |
Mitte. |
TextQuestion
Eine textbasierte Frage.
JSON-Darstellung |
---|
{ "paragraph": boolean } |
Felder | |
---|---|
paragraph |
Gibt an, ob es sich um eine Absatzfrage handelt oder nicht. Andernfalls handelt es sich um eine Frage mit kurzem Text. |
ScaleQuestion
Eine Frage mit einer Skala. Der Nutzer kann aus einer Reihe von numerischen Werten auswählen.
JSON-Darstellung |
---|
{ "low": integer, "high": integer, "lowLabel": string, "highLabel": string } |
Felder | |
---|---|
low |
Erforderlich. Der niedrigste Wert der Skala. |
high |
Erforderlich. Der höchstmögliche Wert für die Skala. |
lowLabel |
Das Label, das für den niedrigsten Punkt auf der Skala angezeigt werden soll. |
highLabel |
Das Label, das den höchsten Punkt auf der Skala beschreibt. |
DateQuestion
Eine Datumsfrage. Bei Datumsfragen wird standardmäßig nur Monat + Tag verwendet.
JSON-Darstellung |
---|
{ "includeTime": boolean, "includeYear": boolean } |
Felder | |
---|---|
includeTime |
Ob die Uhrzeit Teil der Frage sein soll. |
includeYear |
Ob das Jahr in die Frage einbezogen werden soll. |
TimeQuestion
Eine Frage zu Zeit.
JSON-Darstellung |
---|
{ "duration": boolean } |
Felder | |
---|---|
duration |
|
FileUploadQuestion
Eine Frage zum Hochladen einer Datei. Die API unterstützt derzeit nicht das Erstellen von Fragen zum Dateiupload.
JSON-Darstellung |
---|
{
"folderId": string,
"types": [
enum ( |
Felder | |
---|---|
folderId |
Erforderlich. Die ID des Google Drive-Ordners, in dem die hochgeladenen Dateien gespeichert werden. |
types[] |
Dateitypen, die für diese Frage zulässig sind. |
maxFiles |
Maximale Anzahl von Dateien, die für diese Frage in einer einzigen Antwort hochgeladen werden können. |
maxFileSize |
Die maximal zulässige Anzahl von Byte für eine einzelne Datei, die auf diese Frage hochgeladen wird. |
FileType
Dateitypen, die in eine Frage vom Typ „Datei hochladen“ hochgeladen werden können.
Enums | |
---|---|
FILE_TYPE_UNSPECIFIED |
Standardwert Nicht verwendet |
ANY |
Keine Einschränkungen hinsichtlich des Typs. |
DOCUMENT |
Ein Google Docs-Dokument |
PRESENTATION |
Eine Google Präsentationen-Präsentation. |
SPREADSHEET |
Eine Google Tabellen-Tabelle. |
DRAWING |
Eine Zeichnung. |
PDF |
|
IMAGE |
Ein Bild. |
VIDEO |
Ein Video |
AUDIO |
Eine Audiodatei. |
RowQuestion
Konfiguration für eine Frage, die zu einer Fragengruppe gehört.
JSON-Darstellung |
---|
{ "title": string } |
Felder | |
---|---|
title |
Erforderlich. Der Titel für die einzelne Zeile in der |
RatingQuestion
Eine Bewertungsfrage. Der Nutzer kann aus einer Reihe von Symbolen wählen.
JSON-Darstellung |
---|
{
"ratingScaleLevel": integer,
"iconType": enum ( |
Felder | |
---|---|
ratingScaleLevel |
Erforderlich. Die Bewertungsskala der Frage. |
iconType |
Erforderlich. Der Symboltyp, der für die Altersfreigabe verwendet werden soll. |
RatingIconType
Der Typ des Symbols, das für die Altersfreigabe verwendet werden soll.
Enums | |
---|---|
RATING_ICON_TYPE_UNSPECIFIED |
Standardwert Nicht verwendet |
STAR |
Ein Sternsymbol. |
HEART |
Ein Herzsymbol. |
THUMB_UP |
Ein Symbol mit einem nach unten gerichteten Daumen. |
Benotung
Antworten auf eine einzelne Frage benoten
JSON-Darstellung |
---|
{ "pointValue": integer, "correctAnswers": { object ( |
Felder | |
---|---|
pointValue |
Erforderlich. Die maximale Punktzahl, die ein Teilnehmer automatisch für eine richtige Antwort erhalten kann. Dieser Wert darf nicht negativ sein. |
correctAnswers |
Erforderlich. Der Antwortschlüssel für die Frage. Antworten werden anhand dieses Felds automatisch benotet. |
whenRight |
Das Feedback, das für richtige Antworten angezeigt wird. Dieses Feedback kann nur für Multiple-Choice-Fragen mit richtigen Antworten festgelegt werden. |
whenWrong |
Das Feedback, das für falsche Antworten angezeigt wird. Dieses Feedback kann nur für Multiple-Choice-Fragen mit richtigen Antworten festgelegt werden. |
generalFeedback |
Das Feedback wird für alle Antworten angezeigt. Diese Option wird häufig bei Fragen mit Kurzantworten verwendet, wenn der Quiz-Inhaber den Teilnehmern schnell einen Eindruck davon vermitteln möchte, ob sie die Frage richtig beantwortet haben, bevor sie die Antwort offiziell benoten können. Für automatisch benotete Multiple-Choice-Fragen kann kein allgemeines Feedback festgelegt werden. |
CorrectAnswers
Der Antwortschlüssel für eine Frage.
JSON-Darstellung |
---|
{
"answers": [
{
object ( |
Felder | |
---|---|
answers[] |
Eine Liste mit richtigen Antworten. Eine Quizantwort kann anhand dieser Antworten automatisch benotet werden. Bei Fragen mit nur einer Antwort wird eine Antwort als richtig markiert, wenn sie mit einem Wert in dieser Liste übereinstimmt. Mit anderen Worten: Es sind mehrere richtige Antworten möglich. Bei Fragen mit mehreren möglichen Antworten ( |
CorrectAnswer
Eine einzelne richtige Antwort auf eine Frage. Bei Fragen mit mehreren Werten (CHECKBOX
) sind möglicherweise mehrere CorrectAnswer
erforderlich, um eine einzelne korrekte Antwortoption darzustellen.
JSON-Darstellung |
---|
{ "value": string } |
Felder | |
---|---|
value |
Erforderlich. Der Wert der richtigen Antwort. Weitere Informationen zur Formatierung verschiedener Werttypen finden Sie in der Dokumentation zu |
QuestionGroupItem
Definiert eine Frage, die mehrere Fragen umfasst, die gruppiert sind.
JSON-Darstellung |
---|
{ "questions": [ { object ( |
Felder | |
---|---|
questions[] |
Erforderlich. Eine Liste der Fragen, die zu dieser Fragegruppe gehören. Eine Frage darf nur einer Gruppe angehören. Die |
image |
Das Bild, das in der Fragegruppe über den einzelnen Fragen angezeigt wird. |
Union-Feld kind . Erforderlich. Der Fragegruppentyp, der bestimmt, welche Arten von Fragen zulässig sind und wie sie angezeigt werden. Für kind ist nur einer der folgenden Werte zulässig: |
|
grid |
Die Fragegruppe ist ein Raster mit Zeilen von Multiple-Choice-Fragen mit denselben Optionen. Wenn |
Raster
Ein Raster mit Auswahlmöglichkeiten (Radio- oder Kästchen), wobei jede Zeile eine separate Frage darstellt. Jede Zeile hat dieselben Optionen, die als Spalten angezeigt werden.
JSON-Darstellung |
---|
{
"columns": {
object ( |
Felder | |
---|---|
columns |
Erforderlich. Die Optionen, die für jede Frage im Raster gemeinsam sind. Mit anderen Worten: die Werte der Spalten. Nur |
shuffleQuestions |
Bei |
PageBreakItem
Dieser Typ hat keine Felder.
Seitenumbruch Der Titel und die Beschreibung dieses Elements werden oben auf der neuen Seite angezeigt.
TextItem
Dieser Typ hat keine Felder.
Ein Textelement.
ImageItem
Ein Element, das ein Bild enthält.
JSON-Darstellung |
---|
{
"image": {
object ( |
Felder | |
---|---|
image |
Erforderlich. Das Bild, das im Artikel angezeigt wird. |
VideoItem
Ein Element, das ein Video enthält.
JSON-Darstellung |
---|
{
"video": {
object ( |
Felder | |
---|---|
video |
Erforderlich. Das im Artikel angezeigte Video. |
caption |
Der Text, der unter dem Video angezeigt wird. |
Video
Daten, die ein Video darstellen.
JSON-Darstellung |
---|
{
"youtubeUri": string,
"properties": {
object ( |
Felder | |
---|---|
youtubeUri |
Erforderlich. Eine YouTube-URI. |
properties |
Eigenschaften eines Videos. |
PublishSettings
Die Veröffentlichungseinstellungen eines Formulars.
JSON-Darstellung |
---|
{
"publishState": {
object ( |
Felder | |
---|---|
publishState |
Optional. Der Veröffentlichungsstatus eines Formulars. Beim Aktualisieren von |
PublishState
Der Veröffentlichungsstatus eines Formulars.
JSON-Darstellung |
---|
{ "isPublished": boolean, "isAcceptingResponses": boolean } |
Felder | |
---|---|
isPublished |
Erforderlich. Gibt an, ob das Formular veröffentlicht und für andere sichtbar ist. |
isAcceptingResponses |
Erforderlich. Ob für das Formular Antworten akzeptiert werden. Wenn |
Methoden |
|
---|---|
|
Ändern Sie das Formular mit mehreren Updates. |
|
Erstellen Sie ein neues Formular mit dem Titel, der in der Formularnachricht in der Anfrage angegeben ist. |
|
Holen Sie sich ein Formular. |
|
Aktualisiert die Veröffentlichungseinstellungen eines Formulars. |