Forms Service

Google Formulare

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

// Create a new unpublished form, then add a checkbox question, a multiple choice question,
// a page break, then a date question and a grid of questions, then publish the form and share
// with responders.
var form = FormApp.create('New Form', /* isPublished= */ false);
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']);

form.setPublished(true);
form.addPublishedReaders(['user@example.com', 'group@example.com']);

Logger.log('Published URL: ' + form.getPublishedUrl());
Logger.log('Editor URL: ' + form.getEditUrl());

Klassen

NameKurzbeschreibung
AlignmentEin Enum, das die unterstützten Arten der Bildausrichtung darstellt.
CheckboxGridItemEin Frageelement, das als Raster aus Spalten und Zeilen dargestellt wird und bei dem der Befragte mehrere Optionen pro Zeile aus einer Reihe von Kästchen auswählen kann.
CheckboxGridValidationEine DataValidation für ein CheckboxGridItem.
CheckboxGridValidationBuilderEin DataValidationBuilder für ein CheckboxGridValidation.
CheckboxItemEin Frageelement, mit dem der Befragte ein oder mehrere Kästchen sowie ein optionales Feld „Sonstiges“ auswählen kann.
CheckboxValidationEine DataValidation für ein CheckboxItem.
CheckboxValidationBuilderEin DataValidationBuilder für ein CheckboxValidation.
ChoiceEine einzelne Auswahl, die einem Typ von Item zugeordnet ist, der Auswahlmöglichkeiten unterstützt, z. B. CheckboxItem, ListItem oder MultipleChoiceItem.
DateItemEin Frageelement, mit dem der Teilnehmer ein Datum angeben kann.
DateTimeItemEin Frageelement, mit dem der Teilnehmer ein Datum und eine Uhrzeit angeben kann.
DestinationTypeEin Enum, das die unterstützten Typen von Formularantwortzielen darstellt.
DurationItemEin Frageelement, mit dem der Teilnehmer eine Zeitspanne angeben kann.
FeedbackTypeEin Enum, das die unterstützten Feedbacktypen darstellt.
FormEin Formular, das allgemeine Eigenschaften und Elemente enthält.
FormAppErmöglicht einem Script, eine vorhandene Form zu öffnen oder eine neue zu erstellen.
FormResponseEine Antwort auf das Formular als Ganzes.
GridItemEin Frageelement, das als Raster aus Spalten und Zeilen dargestellt wird und bei dem der Teilnehmer eine Auswahl pro Zeile aus einer Reihe von Optionsfeldern treffen kann.
GridValidationEine DataValidation für ein GridItem.
GridValidationBuilderEin DataValidationBuilder für ein GridValidation.
ImageItemEin Layoutelement, in dem ein Bild angezeigt wird.
ItemEin generisches Formularelement, das Eigenschaften enthält, die allen Elementen gemeinsam sind, z. B. Titel und Hilfetext.
ItemResponseEine Antwort auf eine Frage in einem Formular.
ItemTypeEin Enum, das die unterstützten Typen von Formularelementen darstellt.
ListItemEin Fragetyp, bei dem der Befragte eine Option aus einer Drop-down-Liste auswählen kann.
MultipleChoiceItemEin Frageelement, mit dem der Teilnehmer eine Option aus einer Liste von Optionsfeldern oder ein optionales Feld „Sonstiges“ auswählen kann.
PageBreakItemEin Layoutelement, das den Beginn einer Seite markiert.
PageNavigationTypeEine Aufzählung, die die unterstützten Arten der Seitennavigation darstellt.
ParagraphTextItemEin Frageelement, in dem der Befragte einen Textblock eingeben kann.
ParagraphTextValidationEine DataValidation für ein ParagraphTextItem.
ParagraphTextValidationBuilderEin DataValidationBuilder für ein ParagraphTextValidation.
QuizFeedbackDie Bean-Implementierung eines Feedbacks, das Eigenschaften enthält, die für alle Feedbacks gelten, z. B. Anzeigetext oder Links.
QuizFeedbackBuilderDer Basis-FeedbackBuilder, der Setter für Eigenschaften enthält, die für alle Arten von Feedback gelten, z. B. Anzeigetext.
RatingIconTypeEin Enum, das die unterstützten Arten von Altersfreigabesymbolen darstellt.
RatingItemEin Frageelement, mit dem der Befragte eine Bewertung abgeben kann.
ScaleItemEin Frageelement, bei dem der Teilnehmer eine Option aus einer nummerierten Reihe von Optionsfeldern auswählen kann.
SectionHeaderItemEin Layoutelement, das den Beginn eines Abschnitts visuell kennzeichnet.
TextItemEin Fragetyp, bei dem der Teilnehmer eine einzelne Textzeile eingeben kann.
TextValidationEine DataValidation für ein TextItem.
TextValidationBuilderEin DataValidationBuilder für ein TextValidation.
TimeItemEin Frageelement, mit dem der Teilnehmer eine Tageszeit angeben kann.
VideoItemEin Layoutelement, in dem ein Video angezeigt wird.

Alignment

Attribute

AttributTypBeschreibung
LEFTEnumRichten Sie das Bild an der linken Seite des Formulars aus.
CENTEREnumRichten Sie das Bild in der Mitte des Formulars aus.
RIGHTEnumRichten Sie das Bild rechts im Formular aus.

CheckboxGridItem

Methoden

MethodeRückgabetypKurzbeschreibung
clearValidation()CheckboxGridItemEntfernt die Datenvalidierung für dieses Rasterelement.
createResponse(responses)ItemResponseErstellt ein neues ItemResponse für dieses Kontrollkästchenrasterelement.
duplicate()CheckboxGridItemErstellt eine Kopie dieses Elements und fügt sie am Ende des Formulars ein.
getColumns()String[]Ruft die Werte für jede Spalte im Raster ab.
getHelpText()StringRuft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
getId()IntegerRuft die eindeutige Kennung des Elements ab.
getIndex()IntegerRuft den Index des Elements unter allen Elementen im Formular ab.
getRows()String[]Ruft die Werte für jede Zeile im Raster ab.
getTitle()StringRuft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
getType()ItemTypeRuft den Typ des Elements als ItemType ab.
isRequired()BooleanGibt an, ob der Befragte die Frage beantworten muss.
setColumns(columns)CheckboxGridItemLegt die Spalten des Rasters basierend auf einem Array von Werten fest.
setHelpText(text)CheckboxGridItemLegt den Hilfetext des Elements fest (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
setRequired(enabled)CheckboxGridItemLegt fest, ob der Befragte die Frage beantworten muss.
setRows(rows)CheckboxGridItemLegt die Zeilen des Rasters anhand eines Wertearrays fest.
setTitle(title)CheckboxGridItemLegt den Titel des Elements fest (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
setValidation(validation)CheckboxGridItemLegt die Datenvalidierung für dieses Kontrollkästchenraster-Element fest.

CheckboxGridValidation

CheckboxGridValidationBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
requireLimitOneResponsePerColumn()CheckboxGridValidationBuilderFür ein Rasterelement ist eine Beschränkung auf eine Antwort pro Spalte erforderlich.

CheckboxItem

Methoden

MethodeRückgabetypKurzbeschreibung
clearValidation()CheckboxItemEntfernt die Datenvalidierung für dieses Kontrollkästchen.
createChoice(value)ChoiceErstellt eine neue Auswahl.
createChoice(value, isCorrect)ChoiceErstellt eine neue Auswahl.
createResponse(responses)ItemResponseErstellt ein neues ItemResponse für dieses Kontrollkästchen.
duplicate()CheckboxItemErstellt eine Kopie dieses Elements und fügt sie am Ende des Formulars ein.
getChoices()Choice[]Ruft alle Optionen für ein Element ab.
getFeedbackForCorrect()QuizFeedback|nullGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie eine Frage richtig beantworten.
getFeedbackForIncorrect()QuizFeedback|nullGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie eine Frage falsch beantworten.
getHelpText()StringRuft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
getId()IntegerRuft die eindeutige Kennung des Elements ab.
getIndex()IntegerRuft den Index des Elements unter allen Elementen im Formular ab.
getPoints()IntegerGibt den Punktwert eines bewertbaren Elements zurück.
getTitle()StringRuft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
getType()ItemTypeRuft den Typ des Elements als ItemType ab.
hasOtherOption()BooleanGibt an, ob das Element die Option „Sonstiges“ hat.
isRequired()BooleanGibt an, ob der Befragte 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 das Feedback fest, das den Teilnehmern angezeigt wird, wenn sie eine Frage richtig beantworten.
setFeedbackForIncorrect(feedback)CheckboxItemLegt das Feedback fest, das den Teilnehmern angezeigt wird, wenn sie eine Frage falsch beantworten.
setHelpText(text)CheckboxItemLegt den Hilfetext des Elements fest (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
setPoints(points)CheckboxItemLegt die Anzahl der Punkte fest, die ein bewertbares Element wert ist.
setRequired(enabled)CheckboxItemLegt fest, ob der Befragte die Frage beantworten muss.
setTitle(title)CheckboxItemLegt den Titel des Elements fest (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
setValidation(validation)CheckboxItemLegt die Datenvalidierung für dieses Kontrollkä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 an Optionen ausgewählt werden.
requireSelectAtMost(number)CheckboxValidationBuilderEs müssen höchstens so viele Optionen ausgewählt werden.
requireSelectExactly(number)CheckboxValidationBuilderEs muss genau diese Anzahl an Optionen ausgewählt werden.

Choice

Methoden

MethodeRückgabetypKurzbeschreibung
getGotoPage()PageBreakItemRuft die PageBreakItem ab, die als GO_TO_PAGE-Ziel festgelegt ist, wenn der Antwortende diese Option auswählt und die aktuelle Seite abschließt.
getPageNavigationType()PageNavigationTypeRuft die PageNavigationType ab, die auftritt, wenn der Antwortende diese Option auswählt und die aktuelle Seite abschließt.
getValue()StringRuft den Wert der Auswahl ab, der den Teilnehmern als Label angezeigt wird, wenn sie das Formular aufrufen.
isCorrectAnswer()BooleanRuft ab, ob die Auswahl eine 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 fügt sie am Ende des Formulars ein.
getGeneralFeedback()QuizFeedback|nullGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie auf eine benotbare Frage antworten.
getHelpText()StringRuft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
getId()IntegerRuft die eindeutige Kennung des Elements ab.
getIndex()IntegerRuft den Index des Elements unter allen Elementen im Formular ab.
getPoints()IntegerGibt den Punktwert eines bewertbaren Elements zurück.
getTitle()StringRuft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
getType()ItemTypeRuft den Typ des Elements als ItemType ab.
includesYear()BooleanGibt an, ob das Datumselement eine Jahresoption enthält.
isRequired()BooleanGibt an, ob der Befragte die Frage beantworten muss.
setGeneralFeedback(feedback)DateItemLegt das Feedback fest, das den Teilnehmern angezeigt wird, wenn sie auf eine Frage antworten, die bewertet werden kann, aber keine richtige oder falsche Antwort hat (d. h. Fragen, die manuell bewertet werden müssen).
setHelpText(text)DateItemLegt den Hilfetext des Elements fest (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
setIncludesYear(enableYear)DateItemLegt fest, ob das Datumselement eine Jahreseinstellung enthält.
setPoints(points)DateItemLegt die Anzahl der Punkte fest, die ein bewertbares Element wert ist.
setRequired(enabled)DateItemLegt fest, ob der Befragte die Frage beantworten muss.
setTitle(title)DateItemLegt den Titel des Elements fest (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).

DateTimeItem

Methoden

MethodeRückgabetypKurzbeschreibung
createResponse(response)ItemResponseErstellt ein neues ItemResponse für dieses Datum/Uhrzeit-Element.
duplicate()DateTimeItemErstellt eine Kopie dieses Elements und fügt sie am Ende des Formulars ein.
getGeneralFeedback()QuizFeedback|nullGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie auf eine benotbare Frage antworten.
getHelpText()StringRuft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
getId()IntegerRuft die eindeutige Kennung des Elements ab.
getIndex()IntegerRuft den Index des Elements unter allen Elementen im Formular ab.
getPoints()IntegerGibt den Punktwert eines bewertbaren Elements zurück.
getTitle()StringRuft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
getType()ItemTypeRuft den Typ des Elements als ItemType ab.
includesYear()BooleanGibt an, ob das Datumselement eine Jahresoption enthält.
isRequired()BooleanGibt an, ob der Befragte die Frage beantworten muss.
setGeneralFeedback(feedback)DateTimeItemLegt das Feedback fest, das den Teilnehmern angezeigt wird, wenn sie auf eine Frage antworten, die bewertet werden kann, aber keine richtige oder falsche Antwort hat (d. h. Fragen, die manuell bewertet werden müssen).
setHelpText(text)DateTimeItemLegt den Hilfetext des Elements fest (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
setIncludesYear(enableYear)DateTimeItemLegt fest, ob das Datumselement eine Jahreseinstellung enthält.
setPoints(points)DateTimeItemLegt die Anzahl der Punkte fest, die ein bewertbares Element wert ist.
setRequired(enabled)DateTimeItemLegt fest, ob der Befragte die Frage beantworten muss.
setTitle(title)DateTimeItemLegt den Titel des Elements fest (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).

DestinationType

Attribute

AttributTypBeschreibung
SPREADSHEETEnumEine Google-Tabelle als Ziel 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 fügt sie am Ende des Formulars ein.
getGeneralFeedback()QuizFeedback|nullGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie auf eine benotbare Frage antworten.
getHelpText()StringRuft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
getId()IntegerRuft die eindeutige Kennung des Elements ab.
getIndex()IntegerRuft den Index des Elements unter allen Elementen im Formular ab.
getPoints()IntegerGibt den Punktwert eines bewertbaren Elements zurück.
getTitle()StringRuft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
getType()ItemTypeRuft den Typ des Elements als ItemType ab.
isRequired()BooleanGibt an, ob der Befragte die Frage beantworten muss.
setGeneralFeedback(feedback)DurationItemLegt das Feedback fest, das den Teilnehmern angezeigt wird, wenn sie auf eine Frage antworten, die bewertet werden kann, aber keine richtige oder falsche Antwort hat (d. h. Fragen, die manuell bewertet werden müssen).
setHelpText(text)DurationItemLegt den Hilfetext des Elements fest (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
setPoints(points)DurationItemLegt die Anzahl der Punkte fest, die ein bewertbares Element wert ist.
setRequired(enabled)DurationItemLegt fest, ob der Befragte die Frage beantworten muss.
setTitle(title)DurationItemLegt den Titel des Elements fest (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).

FeedbackType

Attribute

AttributTypBeschreibung
CORRECTEnumFeedback, das den Teilnehmern automatisch angezeigt wird, wenn sie eine Frage richtig beantwortet haben.
INCORRECTEnumFeedback, das den Teilnehmern automatisch angezeigt wird, wenn sie eine Frage falsch beantwortet haben.
GENERALEnumFeedback, das den Teilnehmern automatisch angezeigt wird, wenn sie ihre Antwort senden.

Form

Methoden

MethodeRückgabetypKurzbeschreibung
addCheckboxGridItem()CheckboxGridItemFügt ein neues Frageelement hinzu, das als Raster aus Spalten und Zeilen dargestellt wird. Der Teilnehmer kann pro Zeile mehrere Optionen aus einer Reihe von Kästchen auswählen.
addCheckboxItem()CheckboxItemFügt ein neues Frageelement hinzu, in dem der Teilnehmer ein oder mehrere Kästchen sowie optional ein Feld „Sonstiges“ auswählen kann.
addDateItem()DateItemFügt ein neues Frageelement hinzu, in dem der Befragte ein Datum angeben kann.
addDateTimeItem()DateTimeItemFügt ein neues Frageelement hinzu, in dem der Befragte ein Datum und eine Uhrzeit angeben kann.
addDurationItem()DurationItemFügt ein neues Frageelement hinzu, mit dem der Teilnehmer einen Zeitraum 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 Nutzer-Array der Liste der Bearbeiter für Form hinzu.
addGridItem()GridItemFügt ein neues Frageelement hinzu, das als Raster aus Spalten und Zeilen dargestellt wird. Der Teilnehmer kann pro Zeile eine Option aus einer Reihe von Optionsfeldern auswählen.
addImageItem()ImageItemFügt ein neues Layout-Element hinzu, in dem ein Bild angezeigt wird.
addListItem()ListItemFügt ein neues Frageelement hinzu, mit dem der Befragte eine Option aus einer Drop-down-Liste auswählen kann.
addMultipleChoiceItem()MultipleChoiceItemFügt ein neues Frageelement hinzu, mit dem der Befragte eine Option aus einer Liste von Optionsfeldern oder ein optionales Feld „Sonstiges“ auswählen kann.
addPageBreakItem()PageBreakItemFügt ein neues Layoutelement hinzu, das den Beginn einer Seite markiert.
addParagraphTextItem()ParagraphTextItemFügt eine neue Frage hinzu, in der der Befragte einen Textblock eingeben kann.
addPublishedReader(emailAddress)FormFügt den angegebenen Nutzer der Liste der Antwortenden für die Form hinzu.
addPublishedReader(user)FormFügt den angegebenen Nutzer der Liste der Antwortenden für die Form hinzu.
addPublishedReaders(emailAddresses)FormFügt das angegebene Nutzer-Array der Liste der Antwortenden für Form hinzu.
addRatingItem()RatingItemFügt ein neues Frageelement hinzu, mit dem der Befragte eine Bewertung abgeben kann.
addScaleItem()ScaleItemFügt ein neues Frageelement hinzu, mit dem der Umfrageteilnehmer eine Option aus einer nummerierten Reihe von Optionsfeldern auswählen kann.
addSectionHeaderItem()SectionHeaderItemFügt ein neues Layoutelement hinzu, das den Beginn eines Abschnitts visuell kennzeichnet.
addTextItem()TextItemFügt ein neues Frageelement hinzu, in das der Befragte eine einzelne Textzeile eingeben kann.
addTimeItem()TimeItemFügt ein neues Frageelement hinzu, mit dem der Teilnehmer eine Tageszeit angeben kann.
addVideoItem()VideoItemFügt ein neues Layout-Element hinzu, in dem ein Video angezeigt wird.
canEditResponse()BooleanBestimmt, ob im Formular nach dem Senden einer Antwort ein Link zum Bearbeiten der Antwort angezeigt wird.
collectsEmail()BooleanGibt an, ob im Formular die E‑Mail-Adressen der Umfrageteilnehmer erfasst werden.
createResponse()FormResponseErstellt eine neue Antwort auf das Formular.
deleteAllResponses()FormLöscht alle eingereichten Antworten aus dem Antwortspeicher des Formulars.
deleteItem(index)voidLöscht das Element an einem bestimmten Index unter 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 für das Formular keine Antworten angenommen werden, oder einen leeren String, wenn keine benutzerdefinierte Nachricht festgelegt ist.
getDescription()StringRuft die Beschreibung des Formulars ab.
getDestinationId()StringRuft die ID des Antwortziels des Formulars ab.
getDestinationType()DestinationTypeGibt den Typ des Antwortziels des Formulars zurück.
getEditUrl()StringRuft die URL ab, über die auf den Bearbeitungsmodus des Formulars zugegriffen werden kann.
getEditors()User[]Ruft die Liste der Mitbearbeiter für diese 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.
getPublishedReaders()User[]Ruft die Liste der Antworten für diese Form ab.
getPublishedUrl()StringRuft die URL ab, die zum Beantworten des Formulars verwendet werden kann.
getResponse(responseId)FormResponseRuft eine einzelne Formularantwort anhand ihrer Antwort-ID ab.
getResponses()FormResponse[]Ruft ein Array aller Antworten des Formulars ab.
getResponses(timestamp)FormResponse[]Ruft ein Array aller Antworten des Formulars nach einem bestimmten Datum und einer bestimmten Uhrzeit ab.
getShuffleQuestions()BooleanGibt an, ob die Reihenfolge der Fragen auf jeder Seite des Formulars zufällig ist.
getSummaryUrl()StringRuft die URL ab, die zum Aufrufen einer Zusammenfassung der Antworten des Formulars verwendet werden kann.
getTitle()StringRuft den Titel des Formulars ab.
hasLimitOneResponsePerUser()BooleanGibt an, ob das Formular nur eine Antwort pro Teilnehmer zulässt.
hasProgressBar()BooleanLegt fest, ob im Formular eine Fortschrittsanzeige zu sehen ist.
hasRespondAgainLink()BooleanBestimmt, ob im Formular ein Link zum Senden einer weiteren Antwort angezeigt wird, nachdem ein Teilnehmer das Formular ausgefüllt hat.
isAcceptingResponses()BooleanGibt an, ob für das Formular derzeit Antworten angenommen werden.
isPublished()BooleanGibt an, ob das Formular veröffentlicht ist.
isPublishingSummary()BooleanGibt an, ob im Formular ein Link zum Aufrufen einer Zusammenfassung der Antworten angezeigt wird, nachdem ein Teilnehmer das Formular ausgefüllt hat.
isQuiz()BooleanGibt an, ob es sich bei dem Formular um ein Quiz handelt.
moveItem(from, to)ItemVerschiebt ein Element an einem bestimmten Index unter allen Elementen im Formular an einen anderen bestimmten Index.
moveItem(item, toIndex)ItemVerschiebt ein bestimmtes Element an einen bestimmten Index unter allen Elementen im Formular.
removeDestination()FormHebt die Verknüpfung des Formulars mit dem aktuellen Antwortziel auf.
removeEditor(emailAddress)FormEntfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für die Form.
removeEditor(user)FormEntfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für die Form.
removePublishedReader(emailAddress)FormEntfernt den angegebenen Nutzer aus der Liste der Antwortenden für die Form.
removePublishedReader(user)FormEntfernt den angegebenen Nutzer aus der Liste der Antwortenden für die Form.
setAcceptingResponses(enabled)FormLegt fest, ob für das Formular derzeit Antworten angenommen werden.
setAllowResponseEdits(enabled)FormLegt fest, ob im Formular nach dem Senden einer Antwort ein Link zum Bearbeiten der Antwort 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 die Meldung fest, die angezeigt wird, wenn für das Formular keine Antworten akzeptiert werden.
setDescription(description)FormLegt die Beschreibung des Formulars fest.
setDestination(type, id)FormLegt das Ziel fest, in dem Formularantworten gespeichert werden.
setIsQuiz(enabled)FormLegt fest, ob das Formular ein Quiz ist.
setLimitOneResponsePerUser(enabled)FormLegt fest, ob das Formular nur eine Antwort pro Antwortgeber zulässt.
setProgressBar(enabled)FormLegt fest, ob das Formular eine Fortschrittsanzeige hat.
setPublished(enabled)FormLegt fest, ob das Formular veröffentlicht wird.
setPublishingSummary(enabled)FormLegt fest, ob im Formular ein Link zum Aufrufen einer Zusammenfassung der Antworten angezeigt wird, nachdem ein Teilnehmer das Formular gesendet hat.
setShowLinkToRespondAgain(enabled)FormLegt fest, ob im Formular ein Link zum Senden einer weiteren Antwort angezeigt wird, nachdem ein Teilnehmer das Formular ausgefüllt hat.
setShuffleQuestions(shuffle)FormLegt fest, ob die Reihenfolge der Fragen auf jeder Seite des Formulars zufällig ist.
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)FormReicht Noten für die angegebenen FormResponses ein.
supportsAdvancedResponderPermissions()BooleanGibt an, ob das Formular die Veröffentlichung unterstützt.

FormApp

Attribute

AttributTypBeschreibung
AlignmentAlignmentEine Aufzählung der Arten der Bildausrichtung.
DestinationTypeDestinationTypeEine Aufzählung der Zieltypen, in denen Formularantworten gespeichert werden können.
FeedbackTypeFeedbackTypeEine Aufzählung von Typen der Form Feedbacks.
ItemTypeItemTypeEine Aufzählung von Typen der Form Items.
PageNavigationTypePageNavigationTypeEine Aufzählung der möglichen Verhaltensweisen für die Navigation auf Seiten.
RatingIconTypeRatingIconTypeEine Aufzählung der Bewertungssymboltypen RatingIcons

Methoden

MethodeRückgabetypKurzbeschreibung
create(title)FormErstellt ein neues Form und gibt es zurück.
create(title, isPublished)FormErstellt ein neues Form im angeforderten Veröffentlichungsstatus und gibt es zurück.
createCheckboxGridValidation()CheckboxGridValidationBuilderGibt eine Instanz von CheckboxGridValidationBuilder zurück, mit der die Validierung für ein CheckboxGridItem festgelegt werden kann.
createCheckboxValidation()CheckboxValidationBuilderGibt eine Instanz von CheckboxValidationBuilder zurück, mit der die Validierung für ein CheckboxItem festgelegt werden kann.
createFeedback()QuizFeedbackBuilderGibt eine Instanz von QuizFeedbackBuilder zurück, mit der Feedback für ein bewertbares Item festgelegt werden kann.
createGridValidation()GridValidationBuilderGibt eine Instanz von GridValidationBuilder zurück, mit der die Validierung für eine GridItem festgelegt werden kann.
createParagraphTextValidation()ParagraphTextValidationBuilderGibt eine Instanz von ParagraphTextValidationBuilder zurück, mit der die Validierung für ein ParagraphTextItem festgelegt werden kann.
createTextValidation()TextValidationBuilderGibt eine Instanz von TextValidationBuilder zurück, mit der die Validierung für ein TextItem festgelegt werden kann.
getActiveForm()FormGibt das Formular zurück, an das das Skript containergebunden ist.
getUi()UiGibt eine Instanz der Benutzeroberfläche des Formular-Editors zurück, mit der dem Skript Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzugefügt werden können.
openById(id)FormGibt die Form mit der angegebenen ID zurück.
openByUrl(url)FormGibt das Form mit der angegebenen URL zurück.

FormResponse

Methoden

MethodeRückgabetypKurzbeschreibung
getEditResponseUrl()StringGeneriert eine URL, mit der eine bereits gesendete Antwort bearbeitet werden kann.
getGradableItemResponses()ItemResponse[]Ruft alle Elementantworten ab, die in einer Formularantwort enthalten sind, in derselben Reihenfolge, in der die Elemente im Formular angezeigt werden.
getGradableResponseForItem(item)ItemResponseRuft die in einer Formularantwort enthaltene Antwort für ein bestimmtes Element ab.
getId()String|nullRuft die ID der Formularantwort ab.
getItemResponses()ItemResponse[]Ruft alle Elementantworten ab, die in einer Formularantwort enthalten sind, in derselben Reihenfolge, 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 in dieser Formularantwort enthaltene Elementantwort für ein bestimmtes Element ab.
getTimestamp()DateRuft den Zeitstempel für das Einreichen einer Formularantwort ab.
submit()FormResponseSendet die Antwort.
toPrefilledUrl()StringGeneriert 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 einer Formularantwort die angegebene Antwort auf eine Frage hinzu.

GridItem

Methoden

MethodeRückgabetypKurzbeschreibung
clearValidation()GridItemEntfernt die Datenvalidierung für dieses Rasterelement.
createResponse(responses)ItemResponseErstellt ein neues ItemResponse für dieses Rasterelement.
duplicate()GridItemErstellt eine Kopie dieses Elements und fügt sie am Ende des Formulars ein.
getColumns()String[]Ruft die Werte für jede Spalte im Raster ab.
getHelpText()StringRuft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
getId()IntegerRuft die eindeutige Kennung des Elements ab.
getIndex()IntegerRuft den Index des Elements unter allen Elementen im Formular ab.
getRows()String[]Ruft die Werte für jede Zeile im Raster ab.
getTitle()StringRuft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
getType()ItemTypeRuft den Typ des Elements als ItemType ab.
isRequired()BooleanGibt an, ob der Befragte die Frage beantworten muss.
setColumns(columns)GridItemLegt die Spalten des Rasters basierend auf einem Array von Werten fest.
setHelpText(text)GridItemLegt den Hilfetext des Elements fest (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
setRequired(enabled)GridItemLegt fest, ob der Befragte die Frage beantworten muss.
setRows(rows)GridItemLegt die Zeilen des Rasters anhand eines Wertearrays fest.
setTitle(title)GridItemLegt den Titel des Elements fest (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
setValidation(validation)GridItemLegt die Datenvalidierung für dieses Tabellenelement fest.

GridValidation

GridValidationBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
requireLimitOneResponsePerColumn()GridValidationBuilderFür ein Rasterelement ist eine Beschränkung auf eine Antwort pro Spalte erforderlich.

ImageItem

Methoden

MethodeRückgabetypKurzbeschreibung
duplicate()ImageItemErstellt eine Kopie dieses Elements und fügt sie am Ende des Formulars ein.
getAlignment()AlignmentRuft die horizontale Ausrichtung des Bilds ab.
getHelpText()StringRuft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
getId()IntegerRuft die eindeutige Kennung des Elements ab.
getImage()BlobRuft das Bild ab, das dem Artikel derzeit zugewiesen ist.
getIndex()IntegerRuft den Index des Elements unter allen Elementen im Formular ab.
getTitle()StringRuft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
getType()ItemTypeRuft den Typ des Elements als ItemType ab.
getWidth()IntegerRuft die Breite des Bildes in Pixeln ab.
setAlignment(alignment)ImageItemLegt die horizontale Ausrichtung des Bildes fest.
setHelpText(text)ImageItemLegt den Hilfetext des Elements fest (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
setImage(image)ImageItemLegt das Bild selbst fest.
setTitle(title)ImageItemLegt den Titel des Elements fest (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
setWidth(width)ImageItemLegt die Breite des Bildes in Pixeln fest.

Item

Methoden

MethodeRückgabetypKurzbeschreibung
asCheckboxGridItem()CheckboxGridItemGibt das Element als Checkbox-Rasterelement zurück.
asCheckboxItem()CheckboxItemGibt das Element als Checkbox-Element 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 Dauer-Element zurück.
asGridItem()GridItemGibt das Element als Rasterelement zurück.
asImageItem()ImageItemGibt das Element als Bild 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 Seitenumbruch-Element zurück.
asParagraphTextItem()ParagraphTextItemGibt das Element als Absatztextelement zurück.
asRatingItem()RatingItemGibt das Element als Bewertungselement zurück.
asScaleItem()ScaleItemGibt das Element als Skalenelement zurück.
asSectionHeaderItem()SectionHeaderItemGibt das Element als 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 fügt sie am Ende des Formulars ein.
getHelpText()StringRuft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
getId()IntegerRuft die eindeutige Kennung des Elements ab.
getIndex()IntegerRuft den Index des Elements unter allen Elementen im Formular ab.
getTitle()StringRuft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
getType()ItemTypeRuft den Typ des Elements als ItemType ab.
setHelpText(text)ItemLegt den Hilfetext des Elements fest (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
setTitle(title)ItemLegt den Titel des Elements fest (bei einem SectionHeaderItem manchmal auch als Überschrift 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, auf das sich diese Antwort bezieht.
getResponse()ObjectRuft die Antwort ab, die der Teilnehmer gesendet hat.
getScore()ObjectRuft die Punktzahl für die eingereichte Antwort des Umfrageteilnehmers ab.
setFeedback(feedback)ItemResponseLegt das Feedback fest, das für die eingereichte Antwort des Umfrageteilnehmers angezeigt werden soll.
setScore(score)ItemResponseLegt die Punktzahl für die eingereichte Antwort des Umfrageteilnehmers fest.

ItemType

Attribute

AttributTypBeschreibung
CHECKBOXEnumEin Frageelement, mit dem der Befragte ein oder mehrere Kästchen sowie ein optionales Feld „Sonstiges“ auswählen kann.
CHECKBOX_GRIDEnumEin Frageelement, das als Raster aus Spalten und Zeilen dargestellt wird und bei dem der Befragte mehrere Optionen pro Zeile aus einer Reihe von Kästchen auswählen kann.
DATEEnumEin Frageelement, mit dem der Teilnehmer ein Datum angeben kann.
DATETIMEEnumEin Frageelement, mit dem der Teilnehmer ein Datum und eine Uhrzeit angeben kann.
DURATIONEnumEin Frageelement, mit dem der Teilnehmer eine Zeitspanne angeben kann.
GRIDEnumEin Frageelement, das als Raster aus Spalten und Zeilen dargestellt wird und bei dem der Teilnehmer eine Auswahl pro Zeile aus einer Reihe von Optionsfeldern treffen kann.
IMAGEEnumEin Layoutelement, in dem ein Bild angezeigt wird.
LISTEnumEin Fragetyp, bei dem der Befragte eine Option aus einer Drop-down-Liste auswählen kann.
MULTIPLE_CHOICEEnumEin Frageelement, mit dem der Teilnehmer eine Option aus einer Liste von Optionsfeldern oder ein optionales Feld „Sonstiges“ auswählen kann.
PAGE_BREAKEnumEin Layoutelement, das den Beginn einer Seite markiert.
PARAGRAPH_TEXTEnumEin Frageelement, in dem der Befragte einen Textblock eingeben kann.
RATINGEnumEin Frageelement, mit dem der Befragte eine Bewertung abgeben kann.
SCALEEnumEin Frageelement, bei dem der Umfrageteilnehmer eine Option aus einer nummerierten Reihe von Optionsfeldern auswählen kann.
SECTION_HEADEREnumEin Layoutelement, das den Beginn eines Abschnitts visuell kennzeichnet.
TEXTEnumEin Fragetyp, bei dem der Teilnehmer eine einzelne Textzeile eingeben kann.
TIMEEnumEin Frageelement, mit dem der Teilnehmer eine Tageszeit angeben kann.
VIDEOEnumEin Layout-Element, in dem ein YouTube-Video angezeigt wird
FILE_UPLOADEnumEin Fragetyp, mit dem der Befragte eine Datei hochladen kann.
UNSUPPORTEDEnumEin Element, das derzeit nicht über APIs unterstützt wird.

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 Option zur Seitennavigation, die zu einem bestimmten Seitenumbruch-Element springt.
createChoice(value, navigationType)ChoiceErstellt eine neue Auswahl mit einer Option zur Seitennavigation.
createResponse(response)ItemResponseErstellt ein neues ItemResponse für dieses Listenelement.
duplicate()ListItemErstellt eine Kopie dieses Elements und fügt sie am Ende des Formulars ein.
getChoices()Choice[]Ruft alle Optionen für ein Element ab.
getFeedbackForCorrect()QuizFeedback|nullGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie eine Frage richtig beantworten.
getFeedbackForIncorrect()QuizFeedback|nullGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie eine Frage falsch beantworten.
getHelpText()StringRuft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
getId()IntegerRuft die eindeutige Kennung des Elements ab.
getIndex()IntegerRuft den Index des Elements unter allen Elementen im Formular ab.
getPoints()IntegerGibt den Punktwert eines bewertbaren Elements zurück.
getTitle()StringRuft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
getType()ItemTypeRuft den Typ des Elements als ItemType ab.
isRequired()BooleanGibt an, ob der Befragte 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 das Feedback fest, das den Teilnehmern angezeigt wird, wenn sie eine Frage richtig beantworten.
setFeedbackForIncorrect(feedback)ListItemLegt das Feedback fest, das den Teilnehmern angezeigt wird, wenn sie eine Frage falsch beantworten.
setHelpText(text)ListItemLegt den Hilfetext des Elements fest (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
setPoints(points)ListItemLegt die Anzahl der Punkte fest, die ein bewertbares Element wert ist.
setRequired(enabled)ListItemLegt fest, ob der Befragte die Frage beantworten muss.
setTitle(title)ListItemLegt den Titel des Elements fest (bei einem SectionHeaderItem manchmal auch als Überschrift 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 Option zur Seitennavigation, die zu einem bestimmten Seitenumbruch-Element springt.
createChoice(value, navigationType)ChoiceErstellt eine neue Auswahl mit einer Option zur Seitennavigation.
createResponse(response)ItemResponseErstellt ein neues ItemResponse für dieses Multiple-Choice-Element.
duplicate()MultipleChoiceItemErstellt eine Kopie dieses Elements und fügt sie am Ende des Formulars ein.
getChoices()Choice[]Ruft alle Optionen für ein Element ab.
getFeedbackForCorrect()QuizFeedback|nullGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie eine Frage richtig beantworten.
getFeedbackForIncorrect()QuizFeedback|nullGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie eine Frage falsch beantworten.
getHelpText()StringRuft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
getId()IntegerRuft die eindeutige Kennung des Elements ab.
getIndex()IntegerRuft den Index des Elements unter allen Elementen im Formular ab.
getPoints()IntegerGibt den Punktwert eines bewertbaren Elements zurück.
getTitle()StringRuft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
getType()ItemTypeRuft den Typ des Elements als ItemType ab.
hasOtherOption()BooleanGibt an, ob das Element die Option „Sonstiges“ hat.
isRequired()BooleanGibt an, ob der Befragte 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 das Feedback fest, das den Teilnehmern angezeigt wird, wenn sie eine Frage richtig beantworten.
setFeedbackForIncorrect(feedback)MultipleChoiceItemLegt das Feedback fest, das den Teilnehmern angezeigt wird, wenn sie eine Frage falsch beantworten.
setHelpText(text)MultipleChoiceItemLegt den Hilfetext des Elements fest (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
setPoints(points)MultipleChoiceItemLegt die Anzahl der Punkte fest, die ein bewertbares Element wert ist.
setRequired(enabled)MultipleChoiceItemLegt fest, ob der Befragte die Frage beantworten muss.
setTitle(title)MultipleChoiceItemLegt den Titel des Elements fest (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
showOtherOption(enabled)MultipleChoiceItemLegt fest, ob das Element die Option „Sonstiges“ hat.

PageBreakItem

Methoden

MethodeRückgabetypKurzbeschreibung
duplicate()PageBreakItemErstellt eine Kopie dieses Elements und fügt sie am Ende des Formulars ein.
getGoToPage()PageBreakItemRuft die PageBreakItem ab, zu der das Formular nach Abschluss der Seite vor diesem Seitenumbruch springt (d. h. wenn dieser Seitenumbruch durch normale lineare Weiterleitung durch das Formular erreicht wird).
getHelpText()StringRuft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
getId()IntegerRuft die eindeutige Kennung des Elements ab.
getIndex()IntegerRuft den Index des Elements unter allen Elementen im Formular ab.
getPageNavigationType()PageNavigationTypeRuft den Typ der Seitennavigation ab, die nach dem Ausfüllen der Seite vor diesem Seitenumbruch erfolgt (d. h. wenn dieser Seitenumbruch durch normalen linearen Fortschritt durch das Formular erreicht wird).
getTitle()StringRuft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
getType()ItemTypeRuft den Typ des Elements als ItemType ab.
setGoToPage(goToPageItem)PageBreakItemLegt die Seite fest, zu der gesprungen werden soll, nachdem die Seite vor diesem Seitenumbruch abgeschlossen wurde (d. h. wenn dieser Seitenumbruch durch normales lineares Durchlaufen des Formulars erreicht wird).
setGoToPage(navigationType)PageBreakItemLegt den Typ der Seitennavigation fest, die nach Abschluss der Seite vor diesem Seitenumbruch erfolgt (d. h. wenn dieser Seitenumbruch durch normalen linearen Fortschritt durch das Formular erreicht wird).
setHelpText(text)PageBreakItemLegt den Hilfetext des Elements fest (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
setTitle(title)PageBreakItemLegt den Titel des Elements fest (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).

Attribute

AttributTypBeschreibung
CONTINUEEnumFahren Sie mit der nächsten Seite des Formulars fort, nachdem Sie die aktuelle Seite ausgefüllt haben.
GO_TO_PAGEEnumNach dem Ausfüllen der aktuellen Seite zu einer bestimmten Seite des Formulars springen.
RESTARTEnumDas Formular wird nach Abschluss der aktuellen Seite von Anfang an neu gestartet, ohne dass die bisher eingegebenen Antworten gelöscht werden.
SUBMITEnumSenden Sie die Antwort auf das Formular, nachdem Sie die aktuelle Seite fertig bearbeitet haben.

ParagraphTextItem

Methoden

MethodeRückgabetypKurzbeschreibung
clearValidation()ParagraphTextItemEntfernt die Datenvalidierung für dieses Absatztextelement.
createResponse(response)ItemResponseErstellt ein neues ItemResponse für dieses Absatztextelement.
duplicate()ParagraphTextItemErstellt eine Kopie dieses Elements und fügt sie am Ende des Formulars ein.
getGeneralFeedback()QuizFeedback|nullGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie auf eine benotbare Frage antworten.
getHelpText()StringRuft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
getId()IntegerRuft die eindeutige Kennung des Elements ab.
getIndex()IntegerRuft den Index des Elements unter allen Elementen im Formular ab.
getPoints()IntegerGibt den Punktwert eines bewertbaren Elements zurück.
getTitle()StringRuft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
getType()ItemTypeRuft den Typ des Elements als ItemType ab.
isRequired()BooleanGibt an, ob der Befragte die Frage beantworten muss.
setGeneralFeedback(feedback)ParagraphTextItemLegt das Feedback fest, das den Teilnehmern angezeigt wird, wenn sie auf eine Frage antworten, die bewertet werden kann, aber keine richtige oder falsche Antwort hat (d. h. Fragen, die manuell bewertet werden müssen).
setHelpText(text)ParagraphTextItemLegt den Hilfetext des Elements fest (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
setPoints(points)ParagraphTextItemLegt die Anzahl der Punkte fest, die ein bewertbares Element wert ist.
setRequired(enabled)ParagraphTextItemLegt fest, ob der Befragte die Frage beantworten muss.
setTitle(title)ParagraphTextItemLegt den Titel des Elements fest (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
setValidation(validation)ParagraphTextItemLegt die Datenvalidierung für dieses Absatztextelement fest.

ParagraphTextValidation

ParagraphTextValidationBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
requireTextContainsPattern(pattern)ParagraphTextValidationBuilderDie Antwort muss ein Muster enthalten.
requireTextDoesNotContainPattern(pattern)ParagraphTextValidationBuilderDie Antwort darf kein Muster enthalten.
requireTextDoesNotMatchPattern(pattern)ParagraphTextValidationBuilderDie Antwort darf nicht dem Muster entsprechen.
requireTextLengthGreaterThanOrEqualTo(number)ParagraphTextValidationBuilderDie Antwortlänge muss größer oder gleich dem Wert sein.
requireTextLengthLessThanOrEqualTo(number)ParagraphTextValidationBuilderDie Antwortlänge muss kleiner als der Wert sein.
requireTextMatchesPattern(pattern)ParagraphTextValidationBuilderDie Antwort muss dem Muster entsprechen.

QuizFeedback

Methoden

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

QuizFeedbackBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
addLink(url)QuizFeedbackBuilderFügt einen Link zum zusätzlichen Material des Feedbacks hinzu.
addLink(url, displayText)QuizFeedbackBuilderFügt einen Link zum zusätzlichen 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.

RatingIconType

Attribute

AttributTypBeschreibung
STAREnumEin Sternsymbol.
HEARTEnumEin Herzsymbol
THUMB_UPEnumSymbol „Daumen hoch“

RatingItem

Methoden

MethodeRückgabetypKurzbeschreibung
createResponse(response)ItemResponseErstellt ein neues ItemResponse für dieses Bewertungselement.
duplicate()RatingItemErstellt eine Kopie dieses Elements und fügt sie am Ende des Formulars ein.
getGeneralFeedback()QuizFeedback|nullGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie auf eine benotbare Frage antworten.
getHelpText()StringRuft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
getId()IntegerRuft die eindeutige Kennung des Elements ab.
getIndex()IntegerRuft den Index des Elements unter allen Elementen im Formular ab.
getPoints()IntegerGibt den Punktwert eines bewertbaren Elements zurück.
getRatingIcon()RatingIconTypeRuft das für die Bewertung ausgewählte Symbol ab.
getRatingScaleLevel()IntegerRuft die Skalenstufe der Bewertung ab.
getTitle()StringRuft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
getType()ItemTypeRuft den Typ des Elements als ItemType ab.
isRequired()BooleanGibt an, ob der Befragte die Frage beantworten muss.
setGeneralFeedback(feedback)RatingItemLegt das Feedback fest, das den Teilnehmern angezeigt wird, wenn sie auf eine Frage antworten, die bewertet werden kann, aber keine richtige oder falsche Antwort hat (d. h. Fragen, die manuell bewertet werden müssen).
setHelpText(text)RatingItemLegt den Hilfetext des Elements fest (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
setPoints(points)RatingItemLegt die Anzahl der Punkte fest, die ein bewertbares Element wert ist.
setRatingIcon(ratingIcon)RatingItemLegt das Symbol für die Altersfreigabe fest.
setRatingScaleLevel(ratingScaleLevel)RatingItemLegt die maximale Skalierungsstufe der Bewertung fest.
setRequired(enabled)RatingItemLegt fest, ob der Befragte die Frage beantworten muss.
setTitle(title)RatingItemLegt den Titel des Elements fest (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).

ScaleItem

Methoden

MethodeRückgabetypKurzbeschreibung
createResponse(response)ItemResponseErstellt ein neues ItemResponse für dieses Skalierungselement.
duplicate()ScaleItemErstellt eine Kopie dieses Elements und fügt sie am Ende des Formulars ein.
getGeneralFeedback()QuizFeedback|nullGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie auf eine benotbare Frage antworten.
getHelpText()StringRuft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
getId()IntegerRuft die eindeutige Kennung des Elements ab.
getIndex()IntegerRuft den Index des Elements unter allen Elementen im Formular ab.
getLeftLabel()StringRuft das Label für die Untergrenze der Skala ab, falls vorhanden.
getLowerBound()IntegerGibt die Untergrenze der Skala zurück.
getPoints()IntegerGibt den Punktwert eines bewertbaren Elements zurück.
getRightLabel()StringGibt das Label für die Obergrenze der Skala zurück, falls vorhanden.
getTitle()StringRuft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
getType()ItemTypeRuft den Typ des Elements als ItemType ab.
getUpperBound()IntegerGibt die Obergrenze der Skala zurück.
isRequired()BooleanGibt an, ob der Befragte die Frage beantworten muss.
setBounds(lower, upper)ScaleItemLegt die Unter- und Obergrenze der Skala fest.
setGeneralFeedback(feedback)ScaleItemLegt das Feedback fest, das den Teilnehmern angezeigt wird, wenn sie auf eine Frage antworten, die bewertet werden kann, aber keine richtige oder falsche Antwort hat (d. h. Fragen, die manuell bewertet werden müssen).
setHelpText(text)ScaleItemLegt den Hilfetext des Elements fest (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems 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 bewertbares Element wert ist.
setRequired(enabled)ScaleItemLegt fest, ob der Befragte die Frage beantworten muss.
setTitle(title)ScaleItemLegt den Titel des Elements fest (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).

SectionHeaderItem

Methoden

MethodeRückgabetypKurzbeschreibung
duplicate()SectionHeaderItemErstellt eine Kopie dieses Elements und fügt sie am Ende des Formulars ein.
getHelpText()StringRuft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
getId()IntegerRuft die eindeutige Kennung des Elements ab.
getIndex()IntegerRuft den Index des Elements unter allen Elementen im Formular ab.
getTitle()StringRuft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
getType()ItemTypeRuft den Typ des Elements als ItemType ab.
setHelpText(text)SectionHeaderItemLegt den Hilfetext des Elements fest (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
setTitle(title)SectionHeaderItemLegt den Titel des Elements fest (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).

TextItem

Methoden

MethodeRückgabetypKurzbeschreibung
clearValidation()TextItemEntfernt die Datenvalidierung für dieses Textelement.
createResponse(response)ItemResponseErstellt ein neues ItemResponse für dieses Textelement.
duplicate()TextItemErstellt eine Kopie dieses Elements und fügt sie am Ende des Formulars ein.
getGeneralFeedback()QuizFeedback|nullGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie auf eine benotbare Frage antworten.
getHelpText()StringRuft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
getId()IntegerRuft die eindeutige Kennung des Elements ab.
getIndex()IntegerRuft den Index des Elements unter allen Elementen im Formular ab.
getPoints()IntegerGibt den Punktwert eines bewertbaren Elements zurück.
getTitle()StringRuft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
getType()ItemTypeRuft den Typ des Elements als ItemType ab.
isRequired()BooleanGibt an, ob der Befragte die Frage beantworten muss.
setGeneralFeedback(feedback)TextItemLegt das Feedback fest, das den Teilnehmern angezeigt wird, wenn sie auf eine Frage antworten, die bewertet werden kann, aber keine richtige oder falsche Antwort hat (d. h. Fragen, die manuell bewertet werden müssen).
setHelpText(text)TextItemLegt den Hilfetext des Elements fest (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
setPoints(points)TextItemLegt die Anzahl der Punkte fest, die ein bewertbares Element wert ist.
setRequired(enabled)TextItemLegt fest, ob der Befragte die Frage beantworten muss.
setTitle(title)TextItemLegt den Titel des Elements fest (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
setValidation(validation)TextItemLegt die Datenvalidierung für dieses Textelement fest.

TextValidation

TextValidationBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
requireNumber()TextValidationBuilderErfordert, dass das Textelement eine Zahl ist.
requireNumberBetween(start, end)TextValidationBuilderErfordert, dass das Textelement eine Zahl zwischen „start“ und „end“ (einschließlich) ist.
requireNumberEqualTo(number)TextValidationBuilderDas Textelement muss eine Zahl sein, die dem angegebenen Wert entspricht.
requireNumberGreaterThan(number)TextValidationBuilderDas Textfeld muss eine Zahl größer als der angegebene Wert sein.
requireNumberGreaterThanOrEqualTo(number)TextValidationBuilderErfordert, dass das Textelement eine Zahl ist, die größer oder gleich dem angegebenen Wert ist.
requireNumberLessThan(number)TextValidationBuilderErfordert, dass das Textelement eine Zahl ist, die kleiner als der angegebene Wert ist.
requireNumberLessThanOrEqualTo(number)TextValidationBuilderErfordert, dass das Textelement eine Zahl ist, die kleiner oder gleich dem angegebenen Wert ist.
requireNumberNotBetween(start, end)TextValidationBuilderDas Textelement muss eine Zahl sein, die nicht zwischen „start“ und „end“ liegt (einschließlich).
requireNumberNotEqualTo(number)TextValidationBuilderErfordert, dass das Textelement eine Zahl ist, die nicht dem angegebenen Wert entspricht.
requireTextContainsPattern(pattern)TextValidationBuilderDie Antwort muss ein Muster enthalten.
requireTextDoesNotContainPattern(pattern)TextValidationBuilderDie Antwort darf kein Muster enthalten.
requireTextDoesNotMatchPattern(pattern)TextValidationBuilderDie Antwort darf nicht dem Muster entsprechen.
requireTextIsEmail()TextValidationBuilderDas Textelement muss eine E-Mail-Adresse sein.
requireTextIsUrl()TextValidationBuilderDas Textelement muss eine URL sein.
requireTextLengthGreaterThanOrEqualTo(number)TextValidationBuilderDie Antwortlänge muss größer oder gleich dem Wert sein.
requireTextLengthLessThanOrEqualTo(number)TextValidationBuilderDie Antwortlänge muss kleiner als der Wert sein.
requireTextMatchesPattern(pattern)TextValidationBuilderDie Antwort muss dem Muster 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 fügt sie am Ende des Formulars ein.
getGeneralFeedback()QuizFeedback|nullGibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie auf eine benotbare Frage antworten.
getHelpText()StringRuft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
getId()IntegerRuft die eindeutige Kennung des Elements ab.
getIndex()IntegerRuft den Index des Elements unter allen Elementen im Formular ab.
getPoints()IntegerGibt den Punktwert eines bewertbaren Elements zurück.
getTitle()StringRuft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
getType()ItemTypeRuft den Typ des Elements als ItemType ab.
isRequired()BooleanGibt an, ob der Befragte die Frage beantworten muss.
setGeneralFeedback(feedback)TimeItemLegt das Feedback fest, das den Teilnehmern angezeigt wird, wenn sie auf eine Frage antworten, die bewertet werden kann, aber keine richtige oder falsche Antwort hat (d. h. Fragen, die manuell bewertet werden müssen).
setHelpText(text)TimeItemLegt den Hilfetext des Elements fest (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
setPoints(points)TimeItemLegt die Anzahl der Punkte fest, die ein bewertbares Element wert ist.
setRequired(enabled)TimeItemLegt fest, ob der Befragte die Frage beantworten muss.
setTitle(title)TimeItemLegt den Titel des Elements fest (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).

VideoItem

Methoden

MethodeRückgabetypKurzbeschreibung
duplicate()VideoItemErstellt eine Kopie dieses Elements und fügt sie am Ende des Formulars ein.
getAlignment()AlignmentRuft die horizontale Ausrichtung des Videos ab.
getHelpText()StringRuft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
getId()IntegerRuft die eindeutige Kennung des Elements ab.
getIndex()IntegerRuft den Index des Elements unter allen Elementen im Formular ab.
getTitle()StringRuft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
getType()ItemTypeRuft den Typ des Elements als ItemType ab.
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 (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
setTitle(title)VideoItemLegt den Titel des Elements fest (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).
setVideoUrl(youtubeUrl)VideoItemLegt das Video anhand einer angegebenen YouTube-URL oder YouTube-Video-ID fest.
setWidth(width)VideoItemLegt die Breite des Videos in Pixeln fest.