Forms Service

Google Formulare

Mit diesem Dienst können Skripts Google-Formulare erstellen, aufrufen und ändern.

// Create a new form, then add a checkbox question, a multiple choice question,
// a page break, then a date question and a grid of questions.
var form = FormApp.create('New Form');
var item = form.addCheckboxItem();
item.setTitle('What condiments would you like on your hot dog?');
item.setChoices([
        item.createChoice('Ketchup'),
        item.createChoice('Mustard'),
        item.createChoice('Relish')
    ]);
form.addMultipleChoiceItem()
    .setTitle('Do you prefer cats or dogs?')
    .setChoiceValues(['Cats','Dogs'])
    .showOtherOption(true);
form.addPageBreakItem()
    .setTitle('Getting to know you');
form.addDateItem()
    .setTitle('When were you born?');
form.addGridItem()
    .setTitle('Rate your interests')
    .setRows(['Cars', 'Computers', 'Celebrities'])
    .setColumns(['Boring', 'So-so', 'Interesting']);
Logger.log('Published URL: ' + form.getPublishedUrl());
Logger.log('Editor URL: ' + form.getEditUrl());

Kurse

NameKurzbeschreibung
AlignmentEin Enum-Wert, der die unterstützten Typen der Bildausrichtung darstellt.
CheckboxGridItemEin Frageelement, das als Raster aus Spalten und Zeilen dargestellt wird und es dem Teilnehmer ermöglicht, aus einer Reihe von Kästchen mehrere Auswahlmöglichkeiten pro Zeile auszuwählen.
CheckboxGridValidationEine DataValidation für eine CheckboxGridItem.
CheckboxGridValidationBuilderEin DataValidationBuilder für CheckboxGridValidation.
CheckboxItemEin Frageelement, mit dem der Teilnehmer ein oder mehrere Kästchen auswählen kann, sowie ein optionales Feld "Sonstiges".
CheckboxValidationEine DataValidation für eine CheckboxItem.
CheckboxValidationBuilderEin DataValidationBuilder für CheckboxValidation.
ChoiceEine einzelne Auswahl, die mit einem Item-Typ verknüpft ist, der Auswahlmöglichkeiten wie CheckboxItem, ListItem oder MultipleChoiceItem unterstützt.
DateItemEine Frage, mit der der Teilnehmer ein Datum angeben kann.
DateTimeItemEine Frage, bei der der Befragte ein Datum und eine Uhrzeit angeben kann.
DestinationTypeEin Enum, das die unterstützten Typen von Formularantwortzielen darstellt.
DurationItemEine Frage, mit der der Teilnehmer die Dauer angeben kann.
FeedbackTypeEin Enum-Wert, der die unterstützten Feedbacktypen darstellt.
FormEin Formular, das allgemeine Eigenschaften und Elemente enthält.
FormAppErmöglicht einem Skript, ein vorhandenes Form-Objekt zu öffnen oder ein neues zu erstellen.
FormResponseEine Antwort auf das Formular als Ganzes.
GridItemEin Frageelement, das als Raster aus Spalten und Zeilen dargestellt wird und es dem Befragten ermöglicht, eine Auswahl pro Zeile aus einer Reihe von Optionsfeldern auszuwählen.
GridValidationEine DataValidation für eine GridItem.
GridValidationBuilderEin DataValidationBuilder für GridValidation.
ImageItemEin Layoutelement, das ein Bild anzeigt.
ItemEin generisches Formularelement mit Eigenschaften, die alle Elemente gemeinsam haben, z. B. Titel und Hilfetext.
ItemResponseEine Antwort auf ein bestimmtes Frageelement in einem Formular.
ItemTypeEin Enum-Wert, der die unterstützten Typen von Formularelementen darstellt.
ListItemEine Frage, mit der der Teilnehmer eine Antwort aus einer Drop-down-Liste auswählen kann.
MultipleChoiceItemEin Frageelement, mit dem der Befragte eine Auswahl aus einer Liste von Optionsfeldern oder einem optionalen Feld "Sonstiges" auswählen kann.
PageBreakItemEin Layoutelement, das den Anfang einer Seite markiert.
PageNavigationTypeEin Enum, das die unterstützten Typen der Seitennavigation darstellt.
ParagraphTextItemEine Frage, in die der Befragte einen Textblock eingeben kann.
ParagraphTextValidationEine DataValidation für eine ParagraphTextItem.
ParagraphTextValidationBuilderEin DataValidationBuilder für ParagraphTextValidation.
QuizFeedbackDie Bean-Implementierung eines Feedbacks. Diese enthält Eigenschaften, die für das gesamte Feedback gelten, z. B. Anzeigetext oder Links.
QuizFeedbackBuilderDer Basis-FeedbackBuilder, der Setter für Attribute enthält, die für jegliches Feedback gelten, z. B. Anzeigetext.
ScaleItemEin Frageelement, bei dem der Befragte eine Option aus einer nummerierten Abfolge von Optionsfeldern auswählen kann.
SectionHeaderItemEin Layoutelement, das den Anfang eines Abschnitts visuell anzeigt.
TextItemEine Frage, in die der Befragte eine Textzeile eingeben kann.
TextValidationEine DataValidation für eine TextItem.
TextValidationBuilderEin DataValidationBuilder für TextValidation.
TimeItemEine Frage, bei der die Befragten eine Tageszeit angeben können.
VideoItemEin Layoutelement, das ein Video anzeigt.

Alignment

Attribute

PropertyTypBeschreibung
LEFTEnumRichten Sie das Bild an der linken Seite des Formulars aus.
CENTEREnumRichten Sie das Bild an der Mitte des Formulars aus.
RIGHTEnumRichten Sie das Bild an der rechten Seite des Formulars aus.

CheckboxGridItem

Methoden

MethodeRückgabetypKurzbeschreibung
clearValidation()CheckboxGridItemEntfernt alle Datenvalidierungen für dieses Rasterelement.
createResponse(responses)ItemResponseErstellt ein neues ItemResponse-Element für dieses Kästchen-Rasterelement.
duplicate()CheckboxGridItemErstellt eine Kopie dieses Elements und hängt sie an das Ende des Formulars an.
getColumns()String[]Ruft die Werte für jede Spalte im Raster ab.
getHelpText()Stringden Hilfetext des Elements abrufen (manchmal als Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet)
getId()IntegerRuft die eindeutige ID des Artikels ab.
getIndex()IntegerRuft den Index des Elements aus allen Elementen im Formular ab.
getRows()String[]Ruft die Werte für jede Zeile im Raster ab.
getTitle()StringRuft den Titel des Elements ab (im Fall eines SectionHeaderItem-Elements manchmal auch als Überschrifttext bezeichnet).
getType()ItemTypeRuft den Typ des Elements ab, dargestellt als ItemType.
isRequired()BooleanLegt fest, ob der Teilnehmer die Frage beantworten muss.
setColumns(columns)CheckboxGridItemLegt die Spalten des Rasters auf der Grundlage eines Arrays von Werten fest.
setHelpText(text)CheckboxGridItemLegt den Hilfetext des Elements fest. Bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems wird dieser Text manchmal auch als Beschreibungstext bezeichnet.
setRequired(enabled)CheckboxGridItemLegt fest, ob der Teilnehmer die Frage beantworten muss.
setRows(rows)CheckboxGridItemLegt die Zeilen des Rasters auf der Grundlage eines Arrays von Werten fest.
setTitle(title)CheckboxGridItemLegt den Titel des Elements fest. Bei SectionHeaderItem wird dieser Text manchmal auch als Überschrifttext bezeichnet.
setValidation(validation)CheckboxGridItemLegt die Datenvalidierung für dieses Kästchen-Rasterelement fest.

CheckboxGridValidation

CheckboxGridValidationBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
requireLimitOneResponsePerColumn()CheckboxGridValidationBuilderErfordert das Limit einer Antwort pro Spalte für ein Rasterelement.

CheckboxItem

Methoden

MethodeRückgabetypKurzbeschreibung
clearValidation()CheckboxItemEntfernt alle Datenvalidierungen für dieses Kästchenelement.
createChoice(value)ChoiceErstellt eine neue Auswahl.
createChoice(value, isCorrect)ChoiceErstellt eine neue Auswahl.
createResponse(responses)ItemResponseErstellt ein neues ItemResponse-Element für dieses Kästchenelement.
duplicate()CheckboxItemErstellt eine Kopie dieses Elements und hängt sie an das Ende des Formulars an.
getChoices()Choice[]Ruft alle Auswahlmöglichkeiten für ein Element ab.
getFeedbackForCorrect()QuizFeedbackGibt das Feedback zurück, das den Befragten angezeigt wird, wenn sie eine Frage richtig beantworten.
getFeedbackForIncorrect()QuizFeedbackGibt das Feedback zurück, das den Befragten angezeigt wird, wenn sie eine Frage falsch beantworten.
getHelpText()Stringden Hilfetext des Elements abrufen (manchmal als Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet)
getId()IntegerRuft die eindeutige ID des Artikels ab.
getIndex()IntegerRuft den Index des Elements aus allen Elementen im Formular ab.
getPoints()IntegerGibt die Punktzahl eines benotbaren Elements zurück.
getTitle()StringRuft den Titel des Elements ab (im Fall eines SectionHeaderItem-Elements manchmal auch als Überschrifttext bezeichnet).
getType()ItemTypeRuft den Typ des Elements ab, dargestellt als ItemType.
hasOtherOption()BooleanLegt fest, ob das Element über die Option „Sonstiges“ verfügt.
isRequired()BooleanLegt fest, ob der Teilnehmer die Frage beantworten muss.
setChoiceValues(values)CheckboxItemLegt die Auswahlmöglichkeiten für ein Element aus einem String-Array fest.
setChoices(choices)CheckboxItemLegt ein Array mit Auswahlmöglichkeiten für ein Element fest.
setFeedbackForCorrect(feedback)CheckboxItemLegt fest, dass das Feedback den Befragten angezeigt wird, wenn sie eine Frage richtig beantworten.
setFeedbackForIncorrect(feedback)CheckboxItemLegt fest, dass das Feedback den Befragten angezeigt wird, wenn sie eine Frage falsch beantworten.
setHelpText(text)CheckboxItemLegt den Hilfetext des Elements fest. Bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems wird dieser Text manchmal auch als Beschreibungstext bezeichnet.
setPoints(points)CheckboxItemLegt die Anzahl der Punkte fest, die ein benotbares Element wert ist.
setRequired(enabled)CheckboxItemLegt fest, ob der Teilnehmer die Frage beantworten muss.
setTitle(title)CheckboxItemLegt den Titel des Elements fest. Bei SectionHeaderItem wird dieser Text manchmal auch als Überschrifttext bezeichnet.
setValidation(validation)CheckboxItemLegt die Datenvalidierung für dieses Kästchenelement fest.
showOtherOption(enabled)CheckboxItemLegt fest, ob das Element die Option „Sonstiges“ hat.

CheckboxValidation

CheckboxValidationBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
requireSelectAtLeast(number)CheckboxValidationBuilderEs muss mindestens diese Anzahl von Auswahlmöglichkeiten ausgewählt werden.
requireSelectAtMost(number)CheckboxValidationBuilderEs muss höchstens diese Anzahl von Auswahlmöglichkeiten ausgewählt werden.
requireSelectExactly(number)CheckboxValidationBuilderLegen Sie fest, dass genau so viele Auswahlmöglichkeiten ausgewählt werden müssen.

Choice

Methoden

MethodeRückgabetypKurzbeschreibung
getGotoPage()PageBreakItemRuft das PageBreakItem-Objekt ab, das als GO_TO_PAGE-Ziel festgelegt ist, wenn der Bereitsteller diese Auswahl auswählt und die aktuelle Seite abschließt.
getPageNavigationType()PageNavigationTypeRuft das PageNavigationType ab, das auftritt, wenn der Teilnehmer diese Auswahl auswählt und die aktuelle Seite abschließt.
getValue()StringRuft den Wert der Auswahl ab, den die Befragten als Label sehen, wenn sie das Formular anzeigen.
isCorrectAnswer()BooleanErmittelt, ob die Antwort die richtige Antwort auf die Frage ist.

DateItem

Methoden

MethodeRückgabetypKurzbeschreibung
createResponse(response)ItemResponseErstellt ein neues ItemResponse für dieses Datumselement.
duplicate()DateItemErstellt eine Kopie dieses Elements und hängt sie an das Ende des Formulars an.
getGeneralFeedback()QuizFeedbackGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie auf eine benotete Frage antworten.
getHelpText()Stringden Hilfetext des Elements abrufen (manchmal als Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet)
getId()IntegerRuft die eindeutige ID des Artikels ab.
getIndex()IntegerRuft den Index des Elements aus allen Elementen im Formular ab.
getPoints()IntegerGibt die Punktzahl eines benotbaren Elements zurück.
getTitle()StringRuft den Titel des Elements ab (im Fall eines SectionHeaderItem-Elements manchmal auch als Überschrifttext bezeichnet).
getType()ItemTypeRuft den Typ des Elements ab, dargestellt als ItemType.
includesYear()BooleanLegt fest, ob das Datumselement eine Jahresoption enthält.
isRequired()BooleanLegt fest, ob der Teilnehmer die Frage beantworten muss.
setGeneralFeedback(feedback)DateItemLegt fest, dass das Feedback den Teilnehmern angezeigt wird, wenn sie auf eine benotete Frage antworten, die keine richtige oder falsche Antwort hat (z. B. Fragen, die manuell benotet werden müssen).
setHelpText(text)DateItemLegt den Hilfetext des Elements fest. Bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems wird dieser Text manchmal auch als Beschreibungstext bezeichnet.
setIncludesYear(enableYear)DateItemLegt fest, ob das Datumselement eine Jahreseinstellung enthält.
setPoints(points)DateItemLegt die Anzahl der Punkte fest, die ein benotbares Element wert ist.
setRequired(enabled)DateItemLegt fest, ob der Teilnehmer die Frage beantworten muss.
setTitle(title)DateItemLegt den Titel des Elements fest. Bei SectionHeaderItem wird dieser Text manchmal auch als Überschrifttext bezeichnet.

DateTimeItem

Methoden

MethodeRückgabetypKurzbeschreibung
createResponse(response)ItemResponseErstellt ein neues ItemResponse für dieses Datum/Uhrzeit-Element.
duplicate()DateTimeItemErstellt eine Kopie dieses Elements und hängt sie an das Ende des Formulars an.
getGeneralFeedback()QuizFeedbackGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie auf eine benotete Frage antworten.
getHelpText()Stringden Hilfetext des Elements abrufen (manchmal als Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet)
getId()IntegerRuft die eindeutige ID des Artikels ab.
getIndex()IntegerRuft den Index des Elements aus allen Elementen im Formular ab.
getPoints()IntegerGibt die Punktzahl eines benotbaren Elements zurück.
getTitle()StringRuft den Titel des Elements ab (im Fall eines SectionHeaderItem-Elements manchmal auch als Überschrifttext bezeichnet).
getType()ItemTypeRuft den Typ des Elements ab, dargestellt als ItemType.
includesYear()BooleanLegt fest, ob das Datumselement eine Jahresoption enthält.
isRequired()BooleanLegt fest, ob der Teilnehmer die Frage beantworten muss.
setGeneralFeedback(feedback)DateTimeItemLegt fest, dass das Feedback den Teilnehmern angezeigt wird, wenn sie auf eine benotete Frage antworten, die keine richtige oder falsche Antwort hat (z. B. Fragen, die manuell benotet werden müssen).
setHelpText(text)DateTimeItemLegt den Hilfetext des Elements fest. Bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems wird dieser Text manchmal auch als Beschreibungstext bezeichnet.
setIncludesYear(enableYear)DateTimeItemLegt fest, ob das Datumselement eine Jahreseinstellung enthält.
setPoints(points)DateTimeItemLegt die Anzahl der Punkte fest, die ein benotbares Element wert ist.
setRequired(enabled)DateTimeItemLegt fest, ob der Teilnehmer die Frage beantworten muss.
setTitle(title)DateTimeItemLegt den Titel des Elements fest. Bei SectionHeaderItem wird dieser Text manchmal auch als Überschrifttext bezeichnet.

DestinationType

Attribute

PropertyTypBeschreibung
SPREADSHEETEnumEine Tabelle in Google Tabellen als Speicherort für Formularantworten.

DurationItem

Methoden

MethodeRückgabetypKurzbeschreibung
createResponse(hours, minutes, seconds)ItemResponseErstellt ein neues ItemResponse für dieses Datumselement.
duplicate()DurationItemErstellt eine Kopie dieses Elements und hängt sie an das Ende des Formulars an.
getGeneralFeedback()QuizFeedbackGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie auf eine benotete Frage antworten.
getHelpText()Stringden Hilfetext des Elements abrufen (manchmal als Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet)
getId()IntegerRuft die eindeutige ID des Artikels ab.
getIndex()IntegerRuft den Index des Elements aus allen Elementen im Formular ab.
getPoints()IntegerGibt die Punktzahl eines benotbaren Elements zurück.
getTitle()StringRuft den Titel des Elements ab (im Fall eines SectionHeaderItem-Elements manchmal auch als Überschrifttext bezeichnet).
getType()ItemTypeRuft den Typ des Elements ab, dargestellt als ItemType.
isRequired()BooleanLegt fest, ob der Teilnehmer die Frage beantworten muss.
setGeneralFeedback(feedback)DurationItemLegt fest, dass das Feedback den Teilnehmern angezeigt wird, wenn sie auf eine benotete Frage antworten, die keine richtige oder falsche Antwort hat (z. B. Fragen, die manuell benotet werden müssen).
setHelpText(text)DurationItemLegt den Hilfetext des Elements fest. Bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems wird dieser Text manchmal auch als Beschreibungstext bezeichnet.
setPoints(points)DurationItemLegt die Anzahl der Punkte fest, die ein benotbares Element wert ist.
setRequired(enabled)DurationItemLegt fest, ob der Teilnehmer die Frage beantworten muss.
setTitle(title)DurationItemLegt den Titel des Elements fest. Bei SectionHeaderItem wird dieser Text manchmal auch als Überschrifttext bezeichnet.

FeedbackType

Attribute

PropertyTypBeschreibung
CORRECTEnumFeedback, das den Befragten bei richtig beantworteten Fragen automatisch angezeigt wird.
INCORRECTEnumFeedback, das den Teilnehmern für eine falsch beantwortete Frage automatisch angezeigt wird.
GENERALEnumFeedback, das den Befragten automatisch angezeigt wird, wenn sie ihre Antwort absenden.

Form

Methoden

MethodeRückgabetypKurzbeschreibung
addCheckboxGridItem()CheckboxGridItemHängt ein neues Frageelement an, das als Raster aus Spalten und Zeilen dargestellt wird, mit dem der Teilnehmer mehrere Auswahlmöglichkeiten pro Zeile aus einer Reihe von Kästchen auswählen kann.
addCheckboxItem()CheckboxItemFügt ein neues Frageelement hinzu, mit dem der Befragte ein oder mehrere Kästchen sowie ein optionales Feld "Sonstiges" auswählen kann.
addDateItem()DateItemFügt eine neue Frage an, mit der der Teilnehmer ein Datum angeben kann.
addDateTimeItem()DateTimeItemFügt eine neue Frage an, mit der der Teilnehmer ein Datum und eine Uhrzeit angeben kann.
addDurationItem()DurationItemFügt eine neue Frage an, mit der der Teilnehmer die Zeitspanne angeben kann.
addEditor(emailAddress)FormFügt den angegebenen Nutzer der Liste der Bearbeiter für Form hinzu.
addEditor(user)FormFügt den angegebenen Nutzer der Liste der Bearbeiter für Form hinzu.
addEditors(emailAddresses)FormFügt das angegebene Array von Nutzern der Liste der Bearbeiter für Form hinzu.
addGridItem()GridItemHängt ein neues Frageelement an, das als Raster aus Spalten und Zeilen dargestellt wird, mit dem der Befragte eine Auswahl pro Zeile aus einer Reihe von Optionsfeldern auswählen kann.
addImageItem()ImageItemHängt ein neues Layoutelement an, das ein Bild anzeigt.
addListItem()ListItemHängt ein neues Frageelement an, mit dem der Befragte eine Antwort aus einer Drop-down-Liste auswählen kann.
addMultipleChoiceItem()MultipleChoiceItemFügt ein neues Frageelement hinzu, mit dem der Befragte eine Auswahl aus einer Liste von Optionsfeldern oder einem optionalen Feld "Sonstiges" auswählen kann.
addPageBreakItem()PageBreakItemFügt ein neues Layoutelement hinzu, das den Anfang einer Seite markiert.
addParagraphTextItem()ParagraphTextItemFügt eine neue Frage hinzu, in die der Teilnehmer einen Textblock eingeben kann.
addScaleItem()ScaleItemHängt ein neues Frageelement an, mit dem der Befragte eine Option aus einer nummerierten Folge von Optionsfeldern auswählen kann.
addSectionHeaderItem()SectionHeaderItemHängt ein neues Layoutelement an, das den Beginn eines Abschnitts visuell darstellt.
addTextItem()TextItemHängt eine neue Frage an, über die der Teilnehmer eine einzelne Textzeile eingeben kann.
addTimeItem()TimeItemFügt eine neue Frage an, mit der der Teilnehmer eine Tageszeit angeben kann.
addVideoItem()VideoItemHängt ein neues Layoutelement an, das ein Video anzeigt.
canEditResponse()BooleanLegt fest, ob im Formular ein Link zum Bearbeiten einer Antwort nach dem Senden angezeigt wird.
collectsEmail()BooleanLegt fest, ob beim Ausfüllen des Formulars die E-Mail-Adressen der Befragten erfasst werden.
createResponse()FormResponseErstellt eine neue Antwort für das Formular.
deleteAllResponses()FormLöscht alle gesendeten Antworten aus dem Antwortspeicher des Formulars.
deleteItem(index)voidLöscht das Element bei einem bestimmten Index aus allen Elementen im Formular.
deleteItem(item)voidLöscht das angegebene Element.
deleteResponse(responseId)FormLöscht eine einzelne Antwort aus dem Antwortspeicher des Formulars.
getConfirmationMessage()StringRuft die Bestätigungsnachricht des Formulars ab.
getCustomClosedFormMessage()StringRuft die benutzerdefinierte Nachricht ab, die angezeigt wird, wenn das Formular keine Antworten annimmt, oder einen leeren String, wenn keine benutzerdefinierte Nachricht festgelegt wurde.
getDescription()StringRuft die Beschreibung des Formulars ab.
getDestinationId()StringRuft die ID des Antwortziels des Formulars ab.
getDestinationType()DestinationTypeRuft den Typ des Antwortziels des Formulars ab.
getEditUrl()StringRuft die URL ab, über die der Bearbeitungsmodus des Formulars aufgerufen werden kann.
getEditors()User[]Ruft die Liste der Bearbeiter für diesen Form ab.
getId()StringRuft die ID des Formulars ab.
getItemById(id)ItemRuft das Element mit einer bestimmten ID ab.
getItems()Item[]Ruft ein Array aller Elemente im Formular ab.
getItems(itemType)Item[]Ruft ein Array aller Elemente eines bestimmten Typs ab.
getPublishedUrl()StringRuft die URL ab, die zum Ausfüllen des Formulars verwendet werden kann.
getResponse(responseId)FormResponseRuft eine einzelne Formularantwort basierend auf ihrer Antwort-ID ab.
getResponses()FormResponse[]Ruft ein Array aller Formularantworten ab.
getResponses(timestamp)FormResponse[]Ruft ein Array aller Formularantworten nach einem bestimmten Datum und einer bestimmten Uhrzeit ab.
getShuffleQuestions()BooleanHiermit wird festgelegt, ob die Reihenfolge der Fragen auf den einzelnen Seiten des Formulars zufällig ausgewählt wird.
getSummaryUrl()StringRuft die URL ab, über die eine Zusammenfassung der Formularantworten angezeigt werden kann.
getTitle()StringRuft den Titel des Formulars ab.
hasLimitOneResponsePerUser()BooleanBestimmt, ob das Formular nur eine Antwort pro Teilnehmer zulässt.
hasProgressBar()BooleanLegt fest, ob auf dem Formular ein Fortschrittsbalken angezeigt wird.
hasRespondAgainLink()BooleanLegt fest, ob im Formular ein Link zum Senden einer weiteren Antwort angezeigt wird, nachdem ein Teilnehmer das Formular ausgefüllt hat.
isAcceptingResponses()BooleanLegt fest, ob für das Formular derzeit Antworten angenommen werden.
isPublishingSummary()BooleanLegt fest, ob im Formular ein Link angezeigt wird, über den eine Zusammenfassung der Antworten aufgerufen werden kann, nachdem ein Teilnehmer das Formular ausgefüllt hat.
isQuiz()BooleanHiermit wird festgelegt, ob das Formular ein Quiz ist.
moveItem(from, to)ItemVerschiebt ein Element bei einem bestimmten Index zwischen allen Elementen in dem Formular in einen anderen bestimmten Index.
moveItem(item, toIndex)ItemVerschiebt ein bestimmtes Element in einen bestimmten Index unter allen Elementen im Formular.
removeDestination()FormHebt die Verknüpfung des Formulars mit seinem aktuellen Antwortziel auf.
removeEditor(emailAddress)FormEntfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Form.
removeEditor(user)FormEntfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Form.
requiresLogin()BooleanLegt fest, ob sich Befragte in einem Konto in derselben Domain oder in einer Subdomain anmelden müssen, bevor sie antworten.
setAcceptingResponses(enabled)FormLegt fest, ob das Formular derzeit Antworten akzeptiert.
setAllowResponseEdits(enabled)FormLegt fest, ob im Formular ein Link zum Bearbeiten einer Antwort nach dem Senden angezeigt wird.
setCollectEmail(collect)FormLegt fest, ob im Formular die E-Mail-Adressen der Befragten erfasst werden.
setConfirmationMessage(message)FormLegt die Bestätigungsnachricht des Formulars fest.
setCustomClosedFormMessage(message)FormLegt fest, dass die Nachricht angezeigt wird, wenn das Formular keine Antworten akzeptiert.
setDescription(description)FormLegt die Beschreibung des Formulars fest.
setDestination(type, id)FormLegt das Ziel fest, an dem die Formularantworten gespeichert werden.
setIsQuiz(enabled)FormLegt fest, ob das Formular ein Quiz ist.
setLimitOneResponsePerUser(enabled)FormLegt fest, ob im Formular nur eine Antwort pro Teilnehmer zulässig ist.
setProgressBar(enabled)FormLegt fest, ob das Formular eine Fortschrittsanzeige hat.
setPublishingSummary(enabled)FormLegt fest, ob im Formular ein Link angezeigt wird, über den eine Zusammenfassung der Antworten aufgerufen werden kann, nachdem ein Teilnehmer das Formular gesendet hat.
setRequireLogin(requireLogin)FormLegt fest, ob sich Umfrageteilnehmer in einem Konto in derselben Domain oder einer Subdomain anmelden müssen, bevor sie antworten.
setShowLinkToRespondAgain(enabled)FormLegt fest, ob im Formular ein Link zum Senden einer weiteren Antwort angezeigt wird, nachdem ein Befragter das Formular ausgefüllt hat.
setShuffleQuestions(shuffle)FormLegt fest, ob die Fragen auf den einzelnen Seiten des Formulars zufällig angeordnet werden.
setTitle(title)FormLegt den Titel des Formulars fest.
shortenFormUrl(url)StringWandelt eine lange URL für ein Formular in eine kurze URL um.
submitGrades(responses)FormÜbermittelt Noten für die angegebenen FormResponses.

FormApp

Attribute

PropertyTypBeschreibung
AlignmentAlignmentEine Aufzählung der Typen der Bildausrichtung.
DestinationTypeDestinationTypeEine Aufzählung von Zieltypen, die Formularantworten speichern können.
FeedbackTypeFeedbackTypeEine Aufzählung der Typen des Formulars Feedbacks.
ItemTypeItemTypeEine Aufzählung der Typen des Formulars Items.
PageNavigationTypePageNavigationTypeEine Aufzählung möglicher Verhaltensweisen beim Navigieren auf Seiten.

Methoden

MethodeRückgabetypKurzbeschreibung
create(title)FormErstellt ein neues Form-Objekt und gibt es zurück.
createCheckboxGridValidation()CheckboxGridValidationBuilderGibt eine Instanz eines CheckboxGridValidationBuilder zurück, mit dem die Validierung für ein CheckboxGridItem festgelegt werden kann.
createCheckboxValidation()CheckboxValidationBuilderGibt eine Instanz von CheckboxValidationBuilder zurück, mit der die Validierung für CheckboxItem festgelegt werden kann.
createFeedback()QuizFeedbackBuilderGibt eine Instanz eines QuizFeedbackBuilder zurück, mit dem Feedback zu einem benotbaren Item festgelegt werden kann.
createGridValidation()GridValidationBuilderGibt eine Instanz von GridValidationBuilder zurück, die verwendet werden kann, um die Validierung für einen GridItem festzulegen.
createParagraphTextValidation()ParagraphTextValidationBuilderGibt eine Instanz von ParagraphTextValidationBuilder zurück, mit der die Validierung für einen ParagraphTextItem festgelegt werden kann.
createTextValidation()TextValidationBuilderGibt eine Instanz von TextValidationBuilder zurück, die verwendet werden kann, um die Validierung für einen TextItem festzulegen.
getActiveForm()FormGibt das Formular zurück, in das das Skript containergebunden ist.
getUi()UiGibt eine Instanz der Benutzeroberfläche des Formulareditors zurück, mit der das Skript Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzufügen kann.
openById(id)FormGibt das Form mit der angegebenen ID zurück.
openByUrl(url)FormGibt das Form mit der angegebenen URL zurück.

FormResponse

Methoden

MethodeRückgabetypKurzbeschreibung
getEditResponseUrl()StringHiermit wird eine URL generiert, über die eine bereits gesendete Antwort bearbeitet werden kann.
getGradableItemResponses()ItemResponse[]Ruft alle in einer Formularantwort enthaltenen Elementantworten in der Reihenfolge ab, in der die Elemente im Formular angezeigt werden.
getGradableResponseForItem(item)ItemResponseRuft die Elementantwort ab, die in einer Formularantwort für ein bestimmtes Element enthalten ist.
getId()StringRuft die ID der Formularantwort ab.
getItemResponses()ItemResponse[]Ruft alle in einer Formularantwort enthaltenen Elementantworten in der Reihenfolge ab, in der die Elemente im Formular angezeigt werden.
getRespondentEmail()StringRuft die E-Mail-Adresse der Person ab, die eine Antwort gesendet hat, wenn die Einstellung Form.setCollectEmail(collect) aktiviert ist.
getResponseForItem(item)ItemResponseRuft die Elementantwort für ein bestimmtes Element in dieser Formularantwort ab.
getTimestamp()DateRuft den Zeitstempel für das Senden einer Formularantwort ab.
submit()FormResponseSendet die Antwort.
toPrefilledUrl()StringErzeugt eine URL für das Formular, in dem die Antworten basierend auf den Antworten in dieser Formularantwort vorausgefüllt werden.
withItemGrade(gradedResponse)FormResponseFügt einer Formularantwort die Noten der angegebenen Elementantwort hinzu.
withItemResponse(response)FormResponseFügt die angegebene Elementantwort einer Formularantwort hinzu.

GridItem

Methoden

MethodeRückgabetypKurzbeschreibung
clearValidation()GridItemEntfernt alle Datenvalidierungen für dieses Rasterelement.
createResponse(responses)ItemResponseErstellt ein neues ItemResponse-Element für dieses Rasterelement.
duplicate()GridItemErstellt eine Kopie dieses Elements und hängt sie an das Ende des Formulars an.
getColumns()String[]Ruft die Werte für jede Spalte im Raster ab.
getHelpText()Stringden Hilfetext des Elements abrufen (manchmal als Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet)
getId()IntegerRuft die eindeutige ID des Artikels ab.
getIndex()IntegerRuft den Index des Elements aus allen Elementen im Formular ab.
getRows()String[]Ruft die Werte für jede Zeile im Raster ab.
getTitle()StringRuft den Titel des Elements ab (im Fall eines SectionHeaderItem-Elements manchmal auch als Überschrifttext bezeichnet).
getType()ItemTypeRuft den Typ des Elements ab, dargestellt als ItemType.
isRequired()BooleanLegt fest, ob der Teilnehmer die Frage beantworten muss.
setColumns(columns)GridItemLegt die Spalten des Rasters auf der Grundlage eines Arrays von Werten fest.
setHelpText(text)GridItemLegt den Hilfetext des Elements fest. Bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems wird dieser Text manchmal auch als Beschreibungstext bezeichnet.
setRequired(enabled)GridItemLegt fest, ob der Teilnehmer die Frage beantworten muss.
setRows(rows)GridItemLegt die Zeilen des Rasters auf der Grundlage eines Arrays von Werten fest.
setTitle(title)GridItemLegt den Titel des Elements fest. Bei SectionHeaderItem wird dieser Text manchmal auch als Überschrifttext bezeichnet.
setValidation(validation)GridItemLegt die Datenvalidierung für dieses Rasterelement fest.

GridValidation

GridValidationBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
requireLimitOneResponsePerColumn()GridValidationBuilderErfordert das Limit einer Antwort pro Spalte für ein Rasterelement.

ImageItem

Methoden

MethodeRückgabetypKurzbeschreibung
duplicate()ImageItemErstellt eine Kopie dieses Elements und hängt sie an das Ende des Formulars an.
getAlignment()AlignmentRuft die horizontale Ausrichtung des Bildes ab.
getHelpText()Stringden Hilfetext des Elements abrufen (manchmal als Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet)
getId()IntegerRuft die eindeutige ID des Artikels ab.
getImage()BlobRuft das Bild ab, das dem Element aktuell zugewiesen ist
getIndex()IntegerRuft den Index des Elements aus allen Elementen im Formular ab.
getTitle()StringRuft den Titel des Elements ab (im Fall eines SectionHeaderItem-Elements manchmal auch als Überschrifttext bezeichnet).
getType()ItemTypeRuft den Typ des Elements ab, dargestellt als ItemType.
getWidth()IntegerRuft die Bildbreite in Pixeln ab.
setAlignment(alignment)ImageItemLegt die horizontale Ausrichtung des Bildes fest.
setHelpText(text)ImageItemLegt den Hilfetext des Elements fest. Bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems wird dieser Text manchmal auch als Beschreibungstext bezeichnet.
setImage(image)ImageItemLegt das Bild selbst fest.
setTitle(title)ImageItemLegt den Titel des Elements fest. Bei SectionHeaderItem wird dieser Text manchmal auch als Überschrifttext bezeichnet.
setWidth(width)ImageItemLegt die Breite des Bildes in Pixeln fest.

Item

Methoden

MethodeRückgabetypKurzbeschreibung
asCheckboxGridItem()CheckboxGridItemGibt das Element als Kästchenrasterelement zurück
asCheckboxItem()CheckboxItemGibt das Element als Kästchen zurück.
asDateItem()DateItemGibt das Element als Datumselement zurück
asDateTimeItem()DateTimeItemGibt das Element als Datum/Uhrzeit-Element zurück.
asDurationItem()DurationItemGibt das Element als Dauerelement zurück
asGridItem()GridItemGibt das Element als Rasterelement zurück
asImageItem()ImageItemGibt das Element als Bildelement zurück
asListItem()ListItemGibt das Element als Listenelement zurück
asMultipleChoiceItem()MultipleChoiceItemGibt das Element als Multiple-Choice-Element zurück
asPageBreakItem()PageBreakItemGibt das Element als Seitenumbruchelement zurück
asParagraphTextItem()ParagraphTextItemGibt das Element als Absatz-Textelement zurück
asScaleItem()ScaleItemGibt das Element als Skalenelement zurück.
asSectionHeaderItem()SectionHeaderItemGibt das Element als Element mit Abschnittsüberschrift zurück
asTextItem()TextItemGibt das Element als Textelement zurück
asTimeItem()TimeItemGibt das Element als Zeitelement zurück
asVideoItem()VideoItemGibt das Element als Videoelement zurück
duplicate()ItemErstellt eine Kopie dieses Elements und hängt sie an das Ende des Formulars an.
getHelpText()Stringden Hilfetext des Elements abrufen (manchmal als Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet)
getId()IntegerRuft die eindeutige ID des Artikels ab.
getIndex()IntegerRuft den Index des Elements aus allen Elementen im Formular ab.
getTitle()StringRuft den Titel des Elements ab (im Fall eines SectionHeaderItem-Elements manchmal auch als Überschrifttext bezeichnet).
getType()ItemTypeRuft den Typ des Elements ab, dargestellt als ItemType.
setHelpText(text)ItemLegt den Hilfetext des Elements fest. Bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems wird dieser Text manchmal auch als Beschreibungstext bezeichnet.
setTitle(title)ItemLegt den Titel des Elements fest. Bei SectionHeaderItem wird dieser Text manchmal auch als Überschrifttext bezeichnet.

ItemResponse

Methoden

MethodeRückgabetypKurzbeschreibung
getFeedback()ObjectRuft das Feedback ab, das für die eingereichte Antwort des Befragten gegeben wurde.
getItem()ItemRuft das Frageelement ab, das mit dieser Antwort beantwortet wird.
getResponse()ObjectRuft die vom Teilnehmer gesendete Antwort ab.
getScore()ObjectRuft die Punktzahl für die eingereichte Antwort des Befragten ab.
setFeedback(feedback)ItemResponseLegt das Feedback fest, das für die eingereichte Antwort des Befragten angezeigt werden soll.
setScore(score)ItemResponseLegt die Punktzahl für die eingereichte Antwort des Befragten fest.

ItemType

Attribute

PropertyTypBeschreibung
CHECKBOXEnumEin Frageelement, mit dem der Teilnehmer ein oder mehrere Kästchen auswählen kann, sowie ein optionales Feld "Sonstiges".
CHECKBOX_GRIDEnumEin Frageelement, das als Raster aus Spalten und Zeilen dargestellt wird und es dem Teilnehmer ermöglicht, aus einer Reihe von Kästchen mehrere Auswahlmöglichkeiten pro Zeile auszuwählen.
DATEEnumEine Frage, mit der der Teilnehmer ein Datum angeben kann.
DATETIMEEnumEine Frage, bei der der Befragte ein Datum und eine Uhrzeit angeben kann.
DURATIONEnumEine Frage, mit der der Teilnehmer die Dauer angeben kann.
GRIDEnumEin Frageelement, das als Raster aus Spalten und Zeilen dargestellt wird und es dem Befragten ermöglicht, eine Auswahl pro Zeile aus einer Reihe von Optionsfeldern auszuwählen.
IMAGEEnumEin Layoutelement, das ein Bild anzeigt.
LISTEnumEine Frage, mit der der Teilnehmer eine Antwort aus einer Drop-down-Liste auswählen kann.
MULTIPLE_CHOICEEnumEin Frageelement, mit dem der Befragte eine Auswahl aus einer Liste von Optionsfeldern oder einem optionalen Feld "Sonstiges" auswählen kann.
PAGE_BREAKEnumEin Layoutelement, das den Anfang einer Seite markiert.
PARAGRAPH_TEXTEnumEine Frage, in die der Befragte einen Textblock eingeben kann.
SCALEEnumEin Frageelement, mit dem der Befragte eine Option aus einer nummerierten Folge von Optionsfeldern auswählen kann.
SECTION_HEADEREnumEin Layoutelement, das den Anfang eines Abschnitts visuell anzeigt.
TEXTEnumEine Frage, in die der Befragte eine Textzeile eingeben kann.
TIMEEnumEine Frage, bei der die Befragten eine Tageszeit angeben können.
VIDEOEnumEin Layoutelement, das ein YouTube-Video anzeigt.
FILE_UPLOADEnumEine Frage, mit der die Befragten eine Datei hochladen können.

ListItem

Methoden

MethodeRückgabetypKurzbeschreibung
createChoice(value)ChoiceErstellt eine neue Auswahl.
createChoice(value, isCorrect)ChoiceErstellt eine neue Auswahl.
createChoice(value, navigationItem)ChoiceErstellt eine neue Auswahl mit einer Seitennavigationsoption, die zu einem bestimmten Seitenumbruchelement springt.
createChoice(value, navigationType)ChoiceErstellt eine neue Auswahl mit einer Seitennavigationsoption.
createResponse(response)ItemResponseErstellt ein neues ItemResponse für dieses Listenelement.
duplicate()ListItemErstellt eine Kopie dieses Elements und hängt sie an das Ende des Formulars an.
getChoices()Choice[]Ruft alle Auswahlmöglichkeiten für ein Element ab.
getFeedbackForCorrect()QuizFeedbackGibt das Feedback zurück, das den Befragten angezeigt wird, wenn sie eine Frage richtig beantworten.
getFeedbackForIncorrect()QuizFeedbackGibt das Feedback zurück, das den Befragten angezeigt wird, wenn sie eine Frage falsch beantworten.
getHelpText()Stringden Hilfetext des Elements abrufen (manchmal als Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet)
getId()IntegerRuft die eindeutige ID des Artikels ab.
getIndex()IntegerRuft den Index des Elements aus allen Elementen im Formular ab.
getPoints()IntegerGibt die Punktzahl eines benotbaren Elements zurück.
getTitle()StringRuft den Titel des Elements ab (im Fall eines SectionHeaderItem-Elements manchmal auch als Überschrifttext bezeichnet).
getType()ItemTypeRuft den Typ des Elements ab, dargestellt als ItemType.
isRequired()BooleanLegt fest, ob der Teilnehmer die Frage beantworten muss.
setChoiceValues(values)ListItemLegt die Auswahlmöglichkeiten für ein Element aus einem String-Array fest.
setChoices(choices)ListItemLegt ein Array mit Auswahlmöglichkeiten für ein Element fest.
setFeedbackForCorrect(feedback)ListItemLegt fest, dass das Feedback den Befragten angezeigt wird, wenn sie eine Frage richtig beantworten.
setFeedbackForIncorrect(feedback)ListItemLegt fest, dass das Feedback den Befragten angezeigt wird, wenn sie eine Frage falsch beantworten.
setHelpText(text)ListItemLegt den Hilfetext des Elements fest. Bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems wird dieser Text manchmal auch als Beschreibungstext bezeichnet.
setPoints(points)ListItemLegt die Anzahl der Punkte fest, die ein benotbares Element wert ist.
setRequired(enabled)ListItemLegt fest, ob der Teilnehmer die Frage beantworten muss.
setTitle(title)ListItemLegt den Titel des Elements fest. Bei SectionHeaderItem wird dieser Text manchmal auch als Überschrifttext bezeichnet.

MultipleChoiceItem

Methoden

MethodeRückgabetypKurzbeschreibung
createChoice(value)ChoiceErstellt eine neue Auswahl.
createChoice(value, isCorrect)ChoiceErstellt eine neue Auswahl.
createChoice(value, navigationItem)ChoiceErstellt eine neue Auswahl mit einer Seitennavigationsoption, die zu einem bestimmten Seitenumbruchelement springt.
createChoice(value, navigationType)ChoiceErstellt eine neue Auswahl mit einer Seitennavigationsoption.
createResponse(response)ItemResponseErstellt ein neues ItemResponse für dieses Multiple-Choice-Element.
duplicate()MultipleChoiceItemErstellt eine Kopie dieses Elements und hängt sie an das Ende des Formulars an.
getChoices()Choice[]Ruft alle Auswahlmöglichkeiten für ein Element ab.
getFeedbackForCorrect()QuizFeedbackGibt das Feedback zurück, das den Befragten angezeigt wird, wenn sie eine Frage richtig beantworten.
getFeedbackForIncorrect()QuizFeedbackGibt das Feedback zurück, das den Befragten angezeigt wird, wenn sie eine Frage falsch beantworten.
getHelpText()Stringden Hilfetext des Elements abrufen (manchmal als Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet)
getId()IntegerRuft die eindeutige ID des Artikels ab.
getIndex()IntegerRuft den Index des Elements aus allen Elementen im Formular ab.
getPoints()IntegerGibt die Punktzahl eines benotbaren Elements zurück.
getTitle()StringRuft den Titel des Elements ab (im Fall eines SectionHeaderItem-Elements manchmal auch als Überschrifttext bezeichnet).
getType()ItemTypeRuft den Typ des Elements ab, dargestellt als ItemType.
hasOtherOption()BooleanLegt fest, ob das Element über die Option „Sonstiges“ verfügt.
isRequired()BooleanLegt fest, ob der Teilnehmer die Frage beantworten muss.
setChoiceValues(values)MultipleChoiceItemLegt die Auswahlmöglichkeiten für ein Element aus einem String-Array fest.
setChoices(choices)MultipleChoiceItemLegt ein Array mit Auswahlmöglichkeiten für ein Element fest.
setFeedbackForCorrect(feedback)MultipleChoiceItemLegt fest, dass das Feedback den Befragten angezeigt wird, wenn sie eine Frage richtig beantworten.
setFeedbackForIncorrect(feedback)MultipleChoiceItemLegt fest, dass das Feedback den Befragten angezeigt wird, wenn sie eine Frage falsch beantworten.
setHelpText(text)MultipleChoiceItemLegt den Hilfetext des Elements fest. Bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems wird dieser Text manchmal auch als Beschreibungstext bezeichnet.
setPoints(points)MultipleChoiceItemLegt die Anzahl der Punkte fest, die ein benotbares Element wert ist.
setRequired(enabled)MultipleChoiceItemLegt fest, ob der Teilnehmer die Frage beantworten muss.
setTitle(title)MultipleChoiceItemLegt den Titel des Elements fest. Bei SectionHeaderItem wird dieser Text manchmal auch als Überschrifttext bezeichnet.
showOtherOption(enabled)MultipleChoiceItemLegt fest, ob das Element die Option „Sonstiges“ hat.

PageBreakItem

Methoden

MethodeRückgabetypKurzbeschreibung
duplicate()PageBreakItemErstellt eine Kopie dieses Elements und hängt sie an das Ende des Formulars an.
getGoToPage()PageBreakItemRuft die PageBreakItem ab, zu der das Formular nach dem Ausfüllen der Seite vor diesem Seitenumbruch springt, d. h. beim Erreichen des Seitenumbruchs durch den normalen linearen Verlauf des Formulars.
getHelpText()Stringden Hilfetext des Elements abrufen (manchmal als Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet)
getId()IntegerRuft die eindeutige ID des Artikels ab.
getIndex()IntegerRuft den Index des Elements aus allen Elementen im Formular ab.
getPageNavigationType()PageNavigationTypeRuft den Seitennavigationstyp ab, der nach dem Abschluss der Seite vor diesem Seitenumbruch erfolgt, d. h. beim Erreichen des Seitenumbruchs durch den normalen linearen Verlauf des Formulars.
getTitle()StringRuft den Titel des Elements ab (im Fall eines SectionHeaderItem-Elements manchmal auch als Überschrifttext bezeichnet).
getType()ItemTypeRuft den Typ des Elements ab, dargestellt als ItemType.
setGoToPage(goToPageItem)PageBreakItemLegt fest, zu welcher Seite nach dem Abschluss vor diesem Seitenumbruch gesprungen werden soll, d. h. wenn der Seitenumbruch durch den normalen linearen Verlauf des Formulars erreicht wird.
setGoToPage(navigationType)PageBreakItemLegt die Art der Seitennavigation fest, die nach dem Abschließen der Seite vor diesem Seitenumbruch erfolgt, d. h. wenn dieser Seitenumbruch durch den normalen linearen Verlauf des Formulars erreicht wird.
setHelpText(text)PageBreakItemLegt den Hilfetext des Elements fest. Bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems wird dieser Text manchmal auch als Beschreibungstext bezeichnet.
setTitle(title)PageBreakItemLegt den Titel des Elements fest. Bei SectionHeaderItem wird dieser Text manchmal auch als Überschrifttext bezeichnet.

Attribute

PropertyTypBeschreibung
CONTINUEEnumNachdem Sie die aktuelle Seite ausgefüllt haben, fahren Sie mit der nächsten Seite des Formulars fort.
GO_TO_PAGEEnumNach dem Ausfüllen der aktuellen Seite zu einer bestimmten Seite des Formulars springen.
RESTARTEnumStarten Sie das Formular neu, nachdem Sie die aktuelle Seite ausgefüllt haben, ohne die bisher eingegebenen Antworten zu löschen.
SUBMITEnumSenden Sie die Formularantwort, nachdem Sie die aktuelle Seite ausgefüllt haben.

ParagraphTextItem

Methoden

MethodeRückgabetypKurzbeschreibung
clearValidation()ParagraphTextItemEntfernt alle Datenvalidierungen für dieses Absatz-Textelement.
createResponse(response)ItemResponseErstellt ein neues ItemResponse-Element für dieses Absatztextelement.
duplicate()ParagraphTextItemErstellt eine Kopie dieses Elements und hängt sie an das Ende des Formulars an.
getGeneralFeedback()QuizFeedbackGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie auf eine benotete Frage antworten.
getHelpText()Stringden Hilfetext des Elements abrufen (manchmal als Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet)
getId()IntegerRuft die eindeutige ID des Artikels ab.
getIndex()IntegerRuft den Index des Elements aus allen Elementen im Formular ab.
getPoints()IntegerGibt die Punktzahl eines benotbaren Elements zurück.
getTitle()StringRuft den Titel des Elements ab (im Fall eines SectionHeaderItem-Elements manchmal auch als Überschrifttext bezeichnet).
getType()ItemTypeRuft den Typ des Elements ab, dargestellt als ItemType.
isRequired()BooleanLegt fest, ob der Teilnehmer die Frage beantworten muss.
setGeneralFeedback(feedback)ParagraphTextItemLegt fest, dass das Feedback den Teilnehmern angezeigt wird, wenn sie auf eine benotete Frage antworten, die keine richtige oder falsche Antwort hat (z. B. Fragen, die manuell benotet werden müssen).
setHelpText(text)ParagraphTextItemLegt den Hilfetext des Elements fest. Bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems wird dieser Text manchmal auch als Beschreibungstext bezeichnet.
setPoints(points)ParagraphTextItemLegt die Anzahl der Punkte fest, die ein benotbares Element wert ist.
setRequired(enabled)ParagraphTextItemLegt fest, ob der Teilnehmer die Frage beantworten muss.
setTitle(title)ParagraphTextItemLegt den Titel des Elements fest. Bei SectionHeaderItem wird dieser Text manchmal auch als Überschrifttext bezeichnet.
setValidation(validation)ParagraphTextItemLegt die Datenvalidierung für dieses Absatztextelement fest.

ParagraphTextValidation

ParagraphTextValidationBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
requireTextContainsPattern(pattern)ParagraphTextValidationBuilderErfordert eine Antwort, die ein Muster enthält.
requireTextDoesNotContainPattern(pattern)ParagraphTextValidationBuilderErfordert eine Antwort, die kein Muster enthält.
requireTextDoesNotMatchPattern(pattern)ParagraphTextValidationBuilderErfordert eine Antwort, die nicht mit dem Muster übereinstimmt.
requireTextLengthGreaterThanOrEqualTo(number)ParagraphTextValidationBuilderErfordert, dass die Antwortlänge größer oder gleich dem Wert ist.
requireTextLengthLessThanOrEqualTo(number)ParagraphTextValidationBuilderErfordert, dass die Antwortlänge kleiner als der Wert ist.
requireTextMatchesPattern(pattern)ParagraphTextValidationBuilderErfordert eine Antwort, um dem Muster zu entsprechen.

QuizFeedback

Methoden

MethodeRückgabetypKurzbeschreibung
getLinkUrls()String[]Ruft eine Liste der URLs ab, die dem Feedback zugeordnet sind.
getText()StringRuft den Anzeigetext des Feedbacks ab.

QuizFeedbackBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
addLink(url)QuizFeedbackBuilderFügt einen Link zum ergänzenden Material des Feedbacks hinzu.
addLink(url, displayText)QuizFeedbackBuilderFügt einen Link zum ergänzenden Material des Feedbacks hinzu.
build()QuizFeedbackErstellt ein Feedback des entsprechenden Typs für diesen Builder.
copy()QuizFeedbackBuilderGibt eine Kopie dieses Builders zurück.
setText(text)QuizFeedbackBuilderLegt den Feedbacktext fest.

ScaleItem

Methoden

MethodeRückgabetypKurzbeschreibung
createResponse(response)ItemResponseErstellt eine neue ItemResponse für dieses Waagenelement.
duplicate()ScaleItemErstellt eine Kopie dieses Elements und hängt sie an das Ende des Formulars an.
getGeneralFeedback()QuizFeedbackGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie auf eine benotete Frage antworten.
getHelpText()Stringden Hilfetext des Elements abrufen (manchmal als Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet)
getId()IntegerRuft die eindeutige ID des Artikels ab.
getIndex()IntegerRuft den Index des Elements aus allen Elementen im Formular ab.
getLeftLabel()StringRuft das Label für die Untergrenze der Skala ab, sofern vorhanden.
getLowerBound()IntegerRuft die Untergrenze der Waage ab.
getPoints()IntegerGibt die Punktzahl eines benotbaren Elements zurück.
getRightLabel()StringRuft das Label für die Obergrenze der Skala ab, falls vorhanden.
getTitle()StringRuft den Titel des Elements ab (im Fall eines SectionHeaderItem-Elements manchmal auch als Überschrifttext bezeichnet).
getType()ItemTypeRuft den Typ des Elements ab, dargestellt als ItemType.
getUpperBound()IntegerRuft die Obergrenze der Skala ab.
isRequired()BooleanLegt fest, ob der Teilnehmer die Frage beantworten muss.
setBounds(lower, upper)ScaleItemLegt die Unter- und Obergrenze der Skala fest.
setGeneralFeedback(feedback)ScaleItemLegt fest, dass das Feedback den Teilnehmern angezeigt wird, wenn sie auf eine benotete Frage antworten, die keine richtige oder falsche Antwort hat (z. B. Fragen, die manuell benotet werden müssen).
setHelpText(text)ScaleItemLegt den Hilfetext des Elements fest. Bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems wird dieser Text manchmal auch als Beschreibungstext bezeichnet.
setLabels(lower, upper)ScaleItemLegt Labels für die Unter- und Obergrenze der Skala fest.
setPoints(points)ScaleItemLegt die Anzahl der Punkte fest, die ein benotbares Element wert ist.
setRequired(enabled)ScaleItemLegt fest, ob der Teilnehmer die Frage beantworten muss.
setTitle(title)ScaleItemLegt den Titel des Elements fest. Bei SectionHeaderItem wird dieser Text manchmal auch als Überschrifttext bezeichnet.

SectionHeaderItem

Methoden

MethodeRückgabetypKurzbeschreibung
duplicate()SectionHeaderItemErstellt eine Kopie dieses Elements und hängt sie an das Ende des Formulars an.
getHelpText()Stringden Hilfetext des Elements abrufen (manchmal als Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet)
getId()IntegerRuft die eindeutige ID des Artikels ab.
getIndex()IntegerRuft den Index des Elements aus allen Elementen im Formular ab.
getTitle()StringRuft den Titel des Elements ab (im Fall eines SectionHeaderItem-Elements manchmal auch als Überschrifttext bezeichnet).
getType()ItemTypeRuft den Typ des Elements ab, dargestellt als ItemType.
setHelpText(text)SectionHeaderItemLegt den Hilfetext des Elements fest. Bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems wird dieser Text manchmal auch als Beschreibungstext bezeichnet.
setTitle(title)SectionHeaderItemLegt den Titel des Elements fest. Bei SectionHeaderItem wird dieser Text manchmal auch als Überschrifttext bezeichnet.

TextItem

Methoden

MethodeRückgabetypKurzbeschreibung
clearValidation()TextItemEntfernt alle Datenvalidierungen für dieses Textelement.
createResponse(response)ItemResponseErstellt ein neues ItemResponse-Element für dieses Textelement.
duplicate()TextItemErstellt eine Kopie dieses Elements und hängt sie an das Ende des Formulars an.
getGeneralFeedback()QuizFeedbackGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie auf eine benotete Frage antworten.
getHelpText()Stringden Hilfetext des Elements abrufen (manchmal als Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet)
getId()IntegerRuft die eindeutige ID des Artikels ab.
getIndex()IntegerRuft den Index des Elements aus allen Elementen im Formular ab.
getPoints()IntegerGibt die Punktzahl eines benotbaren Elements zurück.
getTitle()StringRuft den Titel des Elements ab (im Fall eines SectionHeaderItem-Elements manchmal auch als Überschrifttext bezeichnet).
getType()ItemTypeRuft den Typ des Elements ab, dargestellt als ItemType.
isRequired()BooleanLegt fest, ob der Teilnehmer die Frage beantworten muss.
setGeneralFeedback(feedback)TextItemLegt fest, dass das Feedback den Teilnehmern angezeigt wird, wenn sie auf eine benotete Frage antworten, die keine richtige oder falsche Antwort hat (z. B. Fragen, die manuell benotet werden müssen).
setHelpText(text)TextItemLegt den Hilfetext des Elements fest. Bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems wird dieser Text manchmal auch als Beschreibungstext bezeichnet.
setPoints(points)TextItemLegt die Anzahl der Punkte fest, die ein benotbares Element wert ist.
setRequired(enabled)TextItemLegt fest, ob der Teilnehmer die Frage beantworten muss.
setTitle(title)TextItemLegt den Titel des Elements fest. Bei SectionHeaderItem wird dieser Text manchmal auch als Überschrifttext bezeichnet.
setValidation(validation)TextItemLegt die Datenvalidierung für dieses Textelement fest.

TextValidation

TextValidationBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
requireNumber()TextValidationBuilderTextelement muss eine Zahl sein.
requireNumberBetween(start, end)TextValidationBuilderErfordert, dass das Textelement eine Zahl zwischen Start und Ende (einschließlich) ist.
requireNumberEqualTo(number)TextValidationBuilderErfordert, dass das Textelement eine Zahl ist, die dem angegebenen Wert entspricht.
requireNumberGreaterThan(number)TextValidationBuilderErfordert, dass das Textelement eine Zahl größer als der angegebene Wert ist.
requireNumberGreaterThanOrEqualTo(number)TextValidationBuilderErfordert, dass das Textelement eine Zahl größer oder gleich dem angegebenen Wert ist.
requireNumberLessThan(number)TextValidationBuilderErfordert, dass das Textelement eine Zahl kleiner als der angegebene Wert ist.
requireNumberLessThanOrEqualTo(number)TextValidationBuilderErfordert, dass das Textelement eine Zahl kleiner oder gleich dem angegebenen Wert ist.
requireNumberNotBetween(start, end)TextValidationBuilderErfordert, dass das Textelement eine Zahl ist, die nicht zwischen Start und Ende (einschließlich) liegt.
requireNumberNotEqualTo(number)TextValidationBuilderErfordert, dass das Textelement eine Zahl ist, die nicht dem angegebenen Wert entspricht.
requireTextContainsPattern(pattern)TextValidationBuilderErfordert eine Antwort, die ein Muster enthält.
requireTextDoesNotContainPattern(pattern)TextValidationBuilderErfordert eine Antwort, die kein Muster enthält.
requireTextDoesNotMatchPattern(pattern)TextValidationBuilderErfordert eine Antwort, die nicht mit dem Muster übereinstimmt.
requireTextIsEmail()TextValidationBuilderErfordert, dass das Textelement eine E-Mail-Adresse ist.
requireTextIsUrl()TextValidationBuilderErfordert, dass das Textelement eine URL ist.
requireTextLengthGreaterThanOrEqualTo(number)TextValidationBuilderErfordert, dass die Antwortlänge größer oder gleich dem Wert ist.
requireTextLengthLessThanOrEqualTo(number)TextValidationBuilderErfordert, dass die Antwortlänge kleiner als der Wert ist.
requireTextMatchesPattern(pattern)TextValidationBuilderErfordert eine Antwort, um dem Muster zu entsprechen.
requireWholeNumber()TextValidationBuilderErfordert, dass das Textelement eine ganze Zahl ist.

TimeItem

Methoden

MethodeRückgabetypKurzbeschreibung
createResponse(hour, minute)ItemResponseErstellt ein neues ItemResponse für dieses Zeitelement.
duplicate()TimeItemErstellt eine Kopie dieses Elements und hängt sie an das Ende des Formulars an.
getGeneralFeedback()QuizFeedbackGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie auf eine benotete Frage antworten.
getHelpText()Stringden Hilfetext des Elements abrufen (manchmal als Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet)
getId()IntegerRuft die eindeutige ID des Artikels ab.
getIndex()IntegerRuft den Index des Elements aus allen Elementen im Formular ab.
getPoints()IntegerGibt die Punktzahl eines benotbaren Elements zurück.
getTitle()StringRuft den Titel des Elements ab (im Fall eines SectionHeaderItem-Elements manchmal auch als Überschrifttext bezeichnet).
getType()ItemTypeRuft den Typ des Elements ab, dargestellt als ItemType.
isRequired()BooleanLegt fest, ob der Teilnehmer die Frage beantworten muss.
setGeneralFeedback(feedback)TimeItemLegt fest, dass das Feedback den Teilnehmern angezeigt wird, wenn sie auf eine benotete Frage antworten, die keine richtige oder falsche Antwort hat (z. B. Fragen, die manuell benotet werden müssen).
setHelpText(text)TimeItemLegt den Hilfetext des Elements fest. Bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems wird dieser Text manchmal auch als Beschreibungstext bezeichnet.
setPoints(points)TimeItemLegt die Anzahl der Punkte fest, die ein benotbares Element wert ist.
setRequired(enabled)TimeItemLegt fest, ob der Teilnehmer die Frage beantworten muss.
setTitle(title)TimeItemLegt den Titel des Elements fest. Bei SectionHeaderItem wird dieser Text manchmal auch als Überschrifttext bezeichnet.

VideoItem

Methoden

MethodeRückgabetypKurzbeschreibung
duplicate()VideoItemErstellt eine Kopie dieses Elements und hängt sie an das Ende des Formulars an.
getAlignment()AlignmentRuft die horizontale Ausrichtung des Videos ab.
getHelpText()Stringden Hilfetext des Elements abrufen (manchmal als Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet)
getId()IntegerRuft die eindeutige ID des Artikels ab.
getIndex()IntegerRuft den Index des Elements aus allen Elementen im Formular ab.
getTitle()StringRuft den Titel des Elements ab (im Fall eines SectionHeaderItem-Elements manchmal auch als Überschrifttext bezeichnet).
getType()ItemTypeRuft den Typ des Elements ab, dargestellt als ItemType.
getWidth()IntegerRuft die Breite des Videos in Pixeln ab.
setAlignment(alignment)VideoItemLegt die horizontale Ausrichtung des Videos fest.
setHelpText(text)VideoItemLegt den Hilfetext des Elements fest. Bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems wird dieser Text manchmal auch als Beschreibungstext bezeichnet.
setTitle(title)VideoItemLegt den Titel des Elements fest. Bei SectionHeaderItem wird dieser Text manchmal auch als Überschrifttext bezeichnet.
setVideoUrl(youtubeUrl)VideoItemLegt das Video selbst anhand einer bestimmten YouTube-URL oder YouTube-Video-ID fest.
setWidth(width)VideoItemLegt die Breite des Videos in Pixeln fest.