Class ListItem

ListItem

Ein Fragetyp, bei dem der Befragte eine Option aus einer Drop-down-Liste auswählen kann. Auf Elemente kann über eine Form zugegriffen oder sie können über eine Form erstellt werden. 

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?').setChoices([
  item.createChoice('Cats'), item.createChoice('Dogs')
]);

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

Detaillierte Dokumentation

createChoice(value)

Erstellt eine neue Auswahl.

Parameter

NameTypBeschreibung
valueStringDer Wert der Auswahl, der den Teilnehmern als Label angezeigt wird, wenn sie das Formular aufrufen

Rückflug

Choice – die neue Option

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

createChoice(value, isCorrect)

Erstellt eine neue Auswahl.

Parameter

NameTypBeschreibung
valueStringDer Wert der Auswahl, der den Teilnehmern als Label angezeigt wird, wenn sie das Formular aufrufen
isCorrectBooleanob die Auswahl eine richtige Antwort ist

Rückflug

Choice – die neue Option

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

createChoice(value, navigationItem)

Erstellt eine neue Auswahl mit einer Option zur Seitennavigation, die zu einem bestimmten Seitenumbruch-Element springt. Dies entspricht createChoice(value, navigationType) mit navigationType auf FormApp.PageNavigationType.GO_TO_PAGE gesetzt. Antwortmöglichkeiten, die die Seitennavigation verwenden, können nicht im selben Element mit Antwortmöglichkeiten kombiniert werden, die die Seitennavigation nicht verwenden.

Die Seitennavigation erfolgt, nachdem der Teilnehmer eine Seite mit der Option abgeschlossen hat, und nur, wenn er diese Option ausgewählt hat. Wenn der Teilnehmer auf derselben Seite mehrere Optionen mit Anweisungen zur Seitennavigation ausgewählt hat, hat nur die letzte Navigationsoption Auswirkungen. Die Seitennavigation hat auch keine Auswirkungen auf die letzte Seite eines Formulars.

Parameter

NameTypBeschreibung
valueStringDer Wert der Auswahl, der den Teilnehmern als Label angezeigt wird, wenn sie das Formular aufrufen
navigationItemPageBreakItemdas Element, zu dem navigiert werden soll

Rückflug

Choice – die neue Option

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

createChoice(value, navigationType)

Erstellt eine neue Auswahl mit einer Option zur Seitennavigation. Auswahlen, bei denen die Seitennavigation verwendet wird, können nicht im selben Element mit Auswahlen kombiniert werden, bei denen die Seitennavigation nicht verwendet wird.

Die Seitennavigation erfolgt, nachdem der Teilnehmer eine Seite mit der Option abgeschlossen hat, und nur, wenn er diese Option ausgewählt hat. Wenn der Teilnehmer auf derselben Seite mehrere Optionen mit Anweisungen zur Seitennavigation ausgewählt hat, hat nur die letzte Navigationsoption Auswirkungen. Die Seitennavigation hat auch keine Auswirkungen auf die letzte Seite eines Formulars.

Parameter

NameTypBeschreibung
valueStringDer Wert der Auswahl, der den Teilnehmern als Label angezeigt wird, wenn sie das Formular aufrufen
navigationTypePageNavigationTypeNavigationstyp der Auswahl

Rückflug

Choice – die neue Option

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

createResponse(response)

Erstellt ein neues ItemResponse für dieses Listenelement. Löst eine Ausnahme aus, wenn das response-Argument nicht mit einer gültigen Auswahl für dieses Element übereinstimmt.

Parameter

NameTypBeschreibung
responseStringeine gültige Antwort für dieses Listenelement

Rückflug

ItemResponse – die Antwort auf das Element

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

duplicate()

Erstellt eine Kopie dieses Elements und fügt sie am Ende des Formulars ein.

Rückflug

ListItem – ein Duplikat dieses ListItem zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getChoices()

Ruft alle Optionen für ein Element ab.

Rückflug

Choice[]: ein Array mit Auswahlmöglichkeiten

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getFeedbackForCorrect()

Gibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie eine Frage richtig beantworten.

Rückflug

QuizFeedback|null – das Feedback, sofern vorhanden.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getFeedbackForIncorrect()

Gibt das Feedback zurück, das den Teilnehmern angezeigt wird, wenn sie eine Frage falsch beantworten.

Rückflug

QuizFeedback|null – das Feedback, sofern vorhanden.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getHelpText()

Ruft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).

Rückflug

String – der Hilfetext oder die Beschreibung des Artikels

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getId()

Ruft die eindeutige Kennung des Elements ab.

Rückflug

Integer: die ID des Artikels

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getIndex()

Ruft den Index des Elements unter allen Elementen im Formular ab.

Rückflug

Integer: der Index des Elements

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getPoints()

Gibt den Punktwert eines bewertbaren Elements zurück.

Rückflug

Integer: Die Anzahl der Punkte, die eine Frage wert ist.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getTitle()

Ruft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).

Rückflug

String – der Titel oder Headertext des Elements

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getType()

Ruft den Typ des Elements als ItemType ab.

Rückflug

ItemType: Der Typ des Artikels.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

isRequired()

Gibt an, ob der Befragte die Frage beantworten muss.

Rückflug

Boolean – ob der Befragte die Frage beantworten muss

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setChoiceValues(values)

Legt die Auswahlmöglichkeiten für ein Element aus einem String-Array fest. Löst eine Ausnahme aus, wenn das angegebene Array leer ist. 

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoiceValues(['Dogs', 'Cats']);

Parameter

NameTypBeschreibung
valuesString[]Das Array der Auswahlwerte, die den Teilnehmern als Labels angezeigt werden, wenn sie das Formular aufrufen

Rückflug

ListItem – diese ListItem zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setChoices(choices)

Legt ein Array mit Auswahlmöglichkeiten für ein Element fest. Löst eine Ausnahme aus, wenn das angegebene Array leer ist oder ein null-Element enthält. 

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoices([item.createChoice('Cats'), item.createChoice('Dogs')]);

Parameter

NameTypBeschreibung
choicesChoice[]eine Reihe von Optionen

Rückflug

ListItem – diese ListItem zur Verkettung

Löst

Error – wenn das angegebene Array null, leer ist oder ein null-Element enthält

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setFeedbackForCorrect(feedback)

Legt das Feedback fest, das den Teilnehmern angezeigt wird, wenn sie eine Frage richtig beantworten. 

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
// Set "Dogs" as the correct answer to this question.
item.setChoices([
  item.createChoice('Dogs', true),
  item.createChoice('Cats', false),
]);
// Add feedback which will be shown for correct responses; ie "Dogs".
item.setFeedbackForCorrect(
    FormApp.createFeedback().setDisplayText('Dogs rule, cats drool.').build(),
);

Parameter

NameTypBeschreibung
feedbackQuizFeedbackdas neue Feedback. Bei einem Nullwert wird das Feedback gelöscht.

Rückflug

ListItem – diese ListItem zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setFeedbackForIncorrect(feedback)

Legt das Feedback fest, das den Teilnehmern angezeigt wird, wenn sie eine Frage falsch beantworten.

Parameter

NameTypBeschreibung
feedbackQuizFeedbackdas neue Feedback

Rückflug

ListItem – diese ListItem zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setHelpText(text)

Legt den Hilfetext des Elements fest (manchmal auch als Beschreibungstext für Layout-Elemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).

Parameter

NameTypBeschreibung
textStringder neue Hilfetext

Rückflug

ListItem – diese ListItem zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setPoints(points)

Legt die Anzahl der Punkte fest, die ein bewertbares Element wert ist. Der Standardwert für neue Elemente ist 0.

Parameter

NameTypBeschreibung
pointsIntegerdie Anzahl der Punkte, die eine Frage wert ist

Rückflug

ListItem – diese ListItem zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setRequired(enabled)

Legt fest, ob der Befragte die Frage beantworten muss.

Parameter

NameTypBeschreibung
enabledBooleanob der Befragte die Frage beantworten muss

Rückflug

ListItem – das aktuelle Element (zum Verketten)

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setTitle(title)

Legt den Titel des Elements fest (bei einem SectionHeaderItem manchmal auch als Überschrift bezeichnet).

Parameter

NameTypBeschreibung
titleStringden neuen Titel oder Headertext

Rückflug

ListItem – diese ListItem zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms