REST Resource: forms

Ressource: Form

Ein Google Formulare-Dokument. Ein Formular wird in Google Drive erstellt. Das Löschen oder Ändern des Zugriffsschutzes 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)

Formulareinstellungen Dies muss mit UpdateSettingsRequest aktualisiert werden. Er wird während forms.create und UpdateFormInfoRequest ignoriert.

items[]

object (Item)

Erforderlich. Eine Liste der Formularelemente, die z. B. Abschnittsüberschriften, Fragen oder eingebettete Medien 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. Daher sollte sie undurchsichtig behandelt werden. Eine zurückgegebene Überarbeitungs-ID ist nach der Rückgabe nur 24 Stunden lang gültig und kann nicht für andere Nutzer freigegeben werden. Wenn die Überarbeitungs-ID zwischen den Aufrufen unverändert bleibt, 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 Der Formular-URI, der für die Teilnehmer freigegeben werden soll. Daraufhin wird eine Seite geöffnet, auf der der Nutzer Antworten senden, aber die Fragen nicht bearbeiten kann.

linkedSheetId

string

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

Info

Die allgemeinen Informationen zu einem Formular.

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

string

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

documentTitle

string

Nur Ausgabe Der in Google Drive sichtbare Titel des Dokuments. Wenn Info.title leer ist, wird möglicherweise documentTitle an seiner Stelle in der Google Formulare-Benutzeroberfläche angezeigt und ist für die Teilnehmer sichtbar. 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.

FormSettings

Die Einstellungen eines Formulars.

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

object (QuizSettings)

Einstellungen für Quizformulare und Benotung.

QuizSettings

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

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

boolean

Gibt an, ob dieses Formular ein Quiz ist oder nicht. Bei „true“ werden die Antworten auf Grundlage der Frage Grading benotet. Wird sie auf „false“ gesetzt, werden alle Fragen 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

Die Artikel-ID.

Sie kann bei der Erstellung angegeben werden, darf aber nicht bereits 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 einer der folgenden Werte sein:
questionItem

object (QuestionItem)

Dem Nutzer wird eine Frage gestellt.

questionGroupItem

object (QuestionGroupItem)

Sie stellen dem Nutzer eine oder mehrere Fragen mit einer einzigen Hauptaufforderung.

pageBreakItem

object (PageBreakItem)

Startet eine neue Seite mit einem Titel.

textItem

object (TextItem)

Auf der Seite werden ein Titel und eine Beschreibung angezeigt.

imageItem

object (ImageItem)

Zeigt ein Bild auf der Seite an.

videoItem

object (VideoItem)

Zeigt ein Video auf der Seite an.

QuestionItem

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)

Das in der Frage angezeigte Bild.

Frage

Beliebige Frage. Der spezifische Fragetyp ist durch seine 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 Frage-ID.

Sie kann bei der Erstellung angegeben werden, darf aber nicht bereits im Formular verwendet werden. Wenn nicht angegeben, wird eine neue ID zugewiesen.

required

boolean

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

grading

object (Grading)

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

Teilnehmer können aus vordefinierten Optionen wählen.

textQuestion

object (TextQuestion)

Der Teilnehmer kann eine kostenlose Textantwort eingeben.

scaleQuestion

object (ScaleQuestion)

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

dateQuestion

object (DateQuestion)

Der Befragte kann ein Datum eingeben.

timeQuestion

object (TimeQuestion)

Der Befragte kann eine Uhrzeit eingeben.

fileUploadQuestion

object (FileUploadQuestion)

Ein Befragter kann eine oder mehrere Dateien hochladen.

rowQuestion

object (RowQuestion)

Eine Zeile von einem QuestionGroupItem.

ChoiceQuestion

Eine Frage mit einem Optionsfeld oder einem 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 Befragter auswählen muss.

shuffle

boolean

Gibt an, ob die Optionen für verschiedene Instanzen des Quiz in zufälliger Reihenfolge angezeigt werden sollen. Dies wird häufig verwendet, um Betrug von Befragten zu verhindern, die möglicherweise auf den Bildschirm eines anderen Teilnehmers schauen, oder um Voreingenommenheiten in einer Umfrage zu vermeiden, die möglicherweise eingeführt wird, indem immer die gleichen Optionen an erster oder letzter Stelle angezeigt werden.

ChoiceType

Die Art der Auswahl.

Enums
CHOICE_TYPE_UNSPECIFIED Standardwert nicht in Verwendung.
RADIO Optionsfelder: Der Nutzer sieht alle Optionen, sodass er nur eine auswählen kann.
CHECKBOX Kästchen: Der Nutzer sieht alle Auswahlmöglichkeiten und kann eine beliebige Anzahl auswählen.
DROP_DOWN Drop-down-Menü: Die Auswahlmöglichkeiten werden dem Nutzer nur bei Bedarf angezeigt, andernfalls wird nur die aktuelle Auswahl angezeigt. Es kann nur eine Option ausgewählt werden.

Option

Eine 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 angezeigt 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 einem QuestionGroupItem nicht zulässig.

Union-Feld go_to_section. Bereich, zu dem gewechselt werden soll, wenn diese Option ausgewählt wird. 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 für den Abschnitt.

goToSectionId

string

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

GoToAction

Konstanten für die Abschnittsnavigation

Enums
GO_TO_ACTION_UNSPECIFIED Standardwert nicht in Verwendung.
NEXT_SECTION Wechseln Sie zum nächsten Abschnitt.
RESTART_FORM Gehen Sie zurück zum Anfang des Formulars.
SUBMIT_FORM Senden Sie das Formular sofort ab.

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 URI, von dem Sie das Bild herunterladen können. Dieser URI ist nur für begrenzte Zeit gültig.

altText

string

Eine Beschreibung des Bildes, die von Screenreadern vorgelesen wird, wenn der Mauszeiger darauf bewegt wird.

properties

object (MediaProperties)

Eigenschaften eines Bildes.

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, mit dem das Bild eingefügt wird. Der Quell-URI kann beim Abrufen leer sein.

MediaProperties

Eigenschaften des Mediums.

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

enum (Alignment)

Die Position des Mediums.

width

integer

Die Breite des Mediums in Pixeln. Wenn das Medium angezeigt wird, wird es auf den kleineren Wert oder auf die Breite des angezeigten Formulars skaliert. Das ursprüngliche Seitenverhältnis der Medien wird beibehalten. Wenn beim Hinzufügen des Mediums zum Formular keine Breite angegeben wird, wird sie auf die Breite der Medienquelle festgelegt. Die Breite muss zwischen 0 und 740 liegen. Das Festlegen der 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.
RIGHT Rechtsbündig.
CENTER Mitte.

TextQuestion

Eine textbasierte Frage.

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

boolean

Ob es sich um eine Absatzfrage handelt oder nicht Falls nicht, ist die Frage eine kurze Textfrage.

ScaleQuestion

Eine Skala-Frage. 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 Skala.

lowLabel

string

Die anzuzeigende Beschriftung zur Beschreibung des niedrigsten Punkts auf der Waage.

highLabel

string

Die anzuzeigende Beschriftung, die den höchsten Punkt auf der Skala beschreibt.

DateQuestion

Eine Datumsfrage. Bei Datumsfragen werden standardmäßig nur Monat und Tag angezeigt.

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

boolean

Gibt an, ob die Uhrzeit in die Frage aufgenommen werden soll.

includeYear

boolean

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

TimeQuestion

Eine Zeitfrage.

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

boolean

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

FileUploadQuestion

Eine Frage zum Dateiupload. Das Erstellen von Fragen zum Dateiupload wird von der API derzeit nicht unterstützt.

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

string

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

types[]

enum (FileType)

Für diese Frage akzeptierte Dateitypen.

maxFiles

integer

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

maxFileSize

string (int64 format)

Maximal zulässige Anzahl von Byte für eine einzelne Datei, die zu dieser Frage hochgeladen wird.

FileType

Dateitypen, die für eine Frage zum Hochladen von Dateien 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 Als PDF-Datei
IMAGE Ein Bild.
VIDEO Ein Video.
AUDIO Eine Audiodatei.

RowQuestion

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 im 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 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. Die Antworten werden automatisch anhand dieses Felds benotet.

whenRight

object (Feedback)

Das Feedback, das für die richtigen Antworten angezeigt wurde. Dieses Feedback kann nur für Multiple-Choice-Fragen verwendet werden, die richtige Antworten haben.

whenWrong

object (Feedback)

Das Feedback, das für falsche Antworten angezeigt wurde. Dieses Feedback kann nur für Multiple-Choice-Fragen verwendet werden, die richtige Antworten haben.

generalFeedback

object (Feedback)

Das Feedback, das für alle Antworten angezeigt wurde. Diese Option wird häufig für Kurzantwort-Fragen verwendet, wenn der Besitzer eines Quiz den Befragten 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 richtiger Antworten. Quizantworten können anhand dieser Antworten automatisch benotet werden. Bei einwertigen Fragen wird eine Antwort als richtig markiert, wenn sie mit einem Wert in dieser Liste übereinstimmt. Es sind also mehrere richtige Antworten möglich. Bei mehrwertigen Fragen (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 mehrwertigen Fragen (CHECKBOX) sind möglicherweise mehrere CorrectAnswers erforderlich, um eine einzelne richtige Antwortoption darzustellen.

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

string

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

QuestionGroupItem

Definiert eine Frage, die aus mehreren gruppierten Fragen besteht.

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 Fragengruppe gehören. Eine Frage darf nur zu einer Gruppe gehören. Die kind der Gruppe können beeinflussen, welche Arten von Fragen erlaubt sind.

image

object (Image)

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

Union-Feld kind. Erforderlich. Der Typ der Fragengruppe, durch den festgelegt wird, 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 Fragengruppe ist ein Raster mit Zeilen von Multiple-Choice-Fragen, die die gleichen Optionen haben. Wenn grid festgelegt ist, müssen alle Fragen in der Gruppe vom Typ row sein.

Raster

Ein Raster mit Auswahlmöglichkeiten (Radio- oder Kontrollkästchen), wobei jede Zeile eine separate Frage darstellt. Jede Zeile hat die gleichen Auswahlmöglichkeiten, die wie die Spalten angezeigt werden.

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

object (ChoiceQuestion)

Erforderlich. Die Auswahlmöglichkeiten für jede Frage in der Matrix. Mit anderen Worten, die Werte der Spalten. Es sind nur CHECK_BOX- und RADIO-Optionen zulässig.

shuffleQuestions

boolean

Bei true werden die Fragen zufällig angeordnet. Die Zeilen erscheinen also für jeden Befragten in einer anderen Reihenfolge.

PageBreakItem

Ein Seitenumbruch. Titel und Beschreibung dieses Elements werden oben auf der neuen Seite angezeigt.

TextItem

Ein Textelement.

ImageItem

Ein Element, das ein Bild enthält.

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

object (Image)

Erforderlich. Das im Element angezeigte Bild

VideoItem

Ein Element, das ein Video enthält.

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

object (Video)

Erforderlich. Das im Element 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 einem Batch von Aktualisierungen.

create

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

get

Formular abrufen.