REST Resource: forms

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 (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. Titel und Beschreibung des Formulars.

settings

object (FormSettings)

Die Einstellungen des Formulars. Dieser Wert muss mit UpdateSettingsRequest aktualisiert werden. Bei forms.create und UpdateFormInfoRequest wird er ignoriert.

items[]

object (Item)

Erforderlich. Eine Liste der Elemente des Formulars, z. B. Abschnittsüberschriften, Fragen und eingebettete Medien.

revisionId

string

Nur Ausgabe. Die Überarbeitungs-ID des Formulars. Wird in Aktualisierungsanfragen im WriteControl verwendet, um die Revision anzugeben, auf der die Änderungen basieren.

Das Format der Revision-ID kann sich im Laufe der Zeit ändern. Daher sollte es 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 das Formular nicht geä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 jedoch auch auf interne Faktoren wie Änderungen am ID-Format zurückzuführen sein.

responderUri

string

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.

linkedSheetId

string

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

Info

Die allgemeinen Informationen zu einem 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, der in Drive angezeigt wird. Wenn Info.title leer ist, wird an seiner Stelle möglicherweise documentTitle in der Google Forms-Benutzeroberfläche angezeigt und ist für die Teilnehmer sichtbar. documentTitle kann beim Erstellen festgelegt werden, aber nicht durch eine BatchUpdate-Anfrage geändert werden. Verwenden Sie die Google Drive API, wenn Sie documentTitle programmgesteuert aktualisieren möchten.

description

string

Die Beschreibung des Formulars.

FormSettings

Einstellungen eines Formulars

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

object (QuizSettings)

Einstellungen für Quizformulare und die Benotung.

QuizSettings

Einstellungen für Quizformulare und die Benotung. Diese müssen mit der UpdateSettingsRequest aktualisiert werden.

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

boolean

Gibt an, ob es sich bei diesem Formular um ein Quiz handelt. Wenn diese Option aktiviert ist, werden die Antworten anhand von Frage Grading benotet. Wenn Sie „false“ festlegen, werden alle Grading-Fragen gelöscht.

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 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

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

string

Der Titel des Artikels.

description

string

Die Beschreibung des Artikels.

Union-Feld kind. Erforderlich. Die Art des Artikels. Für kind ist nur einer der folgenden Werte zulässig:
questionItem

object (QuestionItem)

Dem Nutzer wird eine Frage gestellt.

questionGroupItem

object (QuestionGroupItem)

Dem Nutzer werden eine oder mehrere Fragen mit einem einzigen Hauptprompt gestellt.

pageBreakItem

object (PageBreakItem)

Startet eine neue Seite mit einem Titel.

textItem

object (TextItem)

Ein Titel und eine Beschreibung werden auf der Seite angezeigt.

imageItem

object (ImageItem)

Zeigt ein Bild auf der Seite an.

videoItem

object (VideoItem)

Ein Video wird auf der Seite angezeigt.

QuestionItem

Ein Formularelement mit einer einzelnen Frage.

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

object (Question)

Erforderlich. Die angezeigte Frage.

image

object (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 (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)
  },
  "ratingQuestion": {
    object (RatingQuestion)
  }
  // End of list of possible types for union field kind.
}
Felder
questionId

string

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

boolean

Ob die Frage beantwortet werden muss, damit ein Teilnehmer seine Antwort einreichen kann.

grading

object (Grading)

Bewertungseinrichtung 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

object (ChoiceQuestion)

Die Befragten können aus einer Reihe von vordefinierten Optionen auswählen.

textQuestion

object (TextQuestion)

Die Teilnehmer können eine Freitextantwort eingeben.

scaleQuestion

object (ScaleQuestion)

Die Teilnehmer können 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 einer QuestionGroupItem.

ratingQuestion

object (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 (ChoiceType),
  "options": [
    {
      object (Option)
    }
  ],
  "shuffle": boolean
}
Felder
type

enum (ChoiceType)

Erforderlich. Der Typ der Auswahlfrage.

options[]

object (Option)

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

shuffle

boolean

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 (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 angezeigt wird.

image

object (Image)

Bild als Option anzeigen

isOther

boolean

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

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

enum (GoToAction)

Navigationstyp des Abschnitts.

goToSectionId

string

Artikel-ID des Abschnittsheaders, zu dem du wechseln möchtest.

GoToAction

Konstanten für die Navigation innerhalb von Abschnitten.

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 (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, über den Sie das Bild herunterladen können. Dieser ist nur für eine begrenzte Zeit gültig.

altText

string

Eine Beschreibung des Bildes, die beim Bewegen des Mauszeigers angezeigt und von Screenreadern vorgelesen wird.

properties

object (MediaProperties)

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

string

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 (Alignment),
  "width": integer
}
Felder
alignment

enum (Alignment)

Position der Medien.

width

integer

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

boolean

Ob es sich bei der Frage um eine Absatzfrage handelt oder nicht. Andernfalls handelt es sich um eine Frage mit kurzem Text.

ScaleQuestion

Eine Frage mit einer Bewertungsskala. Der Nutzer kann aus einer Reihe von numerischen Werten auswählen.

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

integer

Erforderlich. Der niedrigste Wert der Skala.

high

integer

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

lowLabel

string

Das Label, das für den niedrigsten Punkt auf der Skala angezeigt werden soll.

highLabel

string

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

boolean

Ob die Uhrzeit Teil der Frage sein soll.

includeYear

boolean

Ob das Jahr in die Frage einbezogen werden soll.

TimeQuestion

Eine Frage zu Zeit.

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

boolean

true, wenn es um einen vergangenen Zeitraum geht. Andernfalls geht es um eine Tageszeit.

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 (FileType)
  ],
  "maxFiles": integer,
  "maxFileSize": string
}
Felder
folderId

string

Erforderlich. Die ID des Google Drive-Ordners, in dem die hochgeladenen Dateien gespeichert werden.

types[]

enum (FileType)

Dateitypen, die für diese Frage zulässig sind.

maxFiles

integer

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

maxFileSize

string (int64 format)

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 PDF-Datei
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

string

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

RatingQuestion

Eine Bewertungsfrage. Der Nutzer kann aus einer Reihe von Symbolen auswählen.

JSON-Darstellung
{
  "ratingScaleLevel": integer,
  "iconType": enum (RatingIconType)
}
Felder
ratingScaleLevel

integer

Erforderlich. Der Wert auf der Bewertungsskala der Frage.

iconType

enum (RatingIconType)

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 „Mag ich nicht“-Symbol.

Benotung

Benotung für eine einzelne Frage

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

integer

Erforderlich. Die maximale Punktzahl, 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. Antworten werden anhand dieses Felds automatisch benotet.

whenRight

object (Feedback)

Das Feedback, das für richtige Antworten angezeigt wird. Dieses Feedback kann nur für Multiple-Choice-Fragen mit 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 richtigen Antworten festgelegt werden.

generalFeedback

object (Feedback)

Das Feedback wird für alle Antworten angezeigt. Diese Option wird häufig bei Fragen mit Kurzantworten verwendet, wenn der Ersteller des Quiz 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 (CorrectAnswer)
    }
  ]
}
Felder
answers[]

object (CorrectAnswer)

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 (CHECKBOX) wird eine Antwort als richtig markiert, wenn sie genau die Werte in dieser Liste enthält.

CorrectAnswer

Eine einzelne richtige Antwort auf eine Frage. Bei Fragen mit mehreren Antworten (CHECKBOX) sind möglicherweise mehrere CorrectAnswer erforderlich, um eine einzelne richtige Antwortoption darzustellen.

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

string

Erforderlich. Der Wert der richtigen Antwort. Weitere Informationen zur Formatierung verschiedener Werttypen finden Sie in der Dokumentation zu TextAnswer.value.

QuestionGroupItem

Definiert eine Frage, die mehrere Fragen umfasst, die gruppiert 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 der Fragen, die zu dieser Fragegruppe gehören. Eine Frage darf nur einer Gruppe angehören. Die kind der Gruppe kann sich darauf auswirken, welche Arten von Fragen zulässig sind.

image

object (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

object (Grid)

Die Fragegruppe ist ein Raster mit Zeilen von Multiple-Choice-Fragen mit denselben Optionen. Wenn grid festgelegt ist, müssen alle Fragen in der Gruppe vom Typ row sein.

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 (ChoiceQuestion)
  },
  "shuffleQuestions": boolean
}
Felder
columns

object (ChoiceQuestion)

Erforderlich. Die Optionen, die für jede Frage im Raster gemeinsam sind. Mit anderen Worten: die Werte der Spalten. Es sind nur CHECK_BOX und RADIO zulässig.

shuffleQuestions

boolean

Bei true werden die Fragen zufällig angeordnet. Mit anderen Worten: Die Zeilen werden für jeden Teilnehmer in einer anderen Reihenfolge angezeigt.

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 (Image)
  }
}
Felder
image

object (Image)

Erforderlich. Das Bild, das im Artikel angezeigt wird.

VideoItem

Ein Element, das ein Video enthält.

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. Eine YouTube-URI.

properties

object (MediaProperties)

Eigenschaften eines Videos.

Methoden

batchUpdate

Ändern Sie das Formular mit mehreren Updates.

create

Erstellen Sie ein neues Formular mit dem Titel, der in der Formularnachricht in der Anfrage angegeben ist.

get

Holen Sie sich ein Formular.