Class ListItem

ListItem

Eine Frage, mit der der Teilnehmer eine Antwort aus einer Drop-down-Liste auswählen kann. Elemente können über eine Form aufgerufen oder erstellt werden.

// Open a form by ID and add a new list item.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var 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 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.

Detaillierte Dokumentation

createChoice(value)

Erstellt eine neue Auswahl.

Parameter

NameTypBeschreibung
valueStringden Wert der Auswahl, den die Befragten als Label sehen, wenn sie das Formular aufrufen

Return

Choice – die neue Auswahlmöglichkeit

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

createChoice(value, isCorrect)

Erstellt eine neue Auswahl.

Parameter

NameTypBeschreibung
valueStringden Wert der Auswahl, den die Befragten als Label sehen, wenn sie das Formular aufrufen
isCorrectBooleanob die Antwort richtig ist

Return

Choice – die neue Auswahlmöglichkeit

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

createChoice(value, navigationItem)

Erstellt eine neue Auswahl mit einer Seitennavigationsoption, die zu einem bestimmten Seitenumbruchelement springt. Dies entspricht createChoice(value, navigationType), wobei navigationType auf FormApp.PageNavigationType.GO_TO_PAGE festgelegt ist. Auswahlmöglichkeiten, die die Seitennavigation verwenden, können nicht im selben Element mit Auswahlmöglichkeiten kombiniert werden, die keine Seitennavigation verwenden.

Die Seitennavigation findet nur statt, nachdem der Befragte eine Seite mit der Option ausgefüllt hat und diese Option ausgewählt hat. Wenn die befragte Person mehrere Optionen mit Anleitungen zur Seitennavigation auf derselben Seite ausgewählt hat, hat nur die letzte Navigationsoption Auswirkungen. Die Seitennavigation hat auch keine Auswirkungen auf die letzte Seite eines Formulars.

Parameter

NameTypBeschreibung
valueStringden Wert der Auswahl, den die Befragten als Label sehen, wenn sie das Formular aufrufen
navigationItemPageBreakItemdas Element, zu dem

Return

Choice – die neue Auswahlmöglichkeit

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

createChoice(value, navigationType)

Erstellt eine neue Auswahl mit einer Seitennavigationsoption. Auswahlmöglichkeiten, die die Seitennavigation verwenden, können nicht im selben Element mit Auswahlmöglichkeiten kombiniert werden, die keine Seitennavigation verwenden.

Die Seitennavigation findet nur statt, nachdem der Befragte eine Seite mit der Option ausgefüllt hat und diese Option ausgewählt hat. Wenn die befragte Person mehrere Optionen mit Anleitungen zur Seitennavigation auf derselben Seite ausgewählt hat, hat nur die letzte Navigationsoption Auswirkungen. Die Seitennavigation hat auch keine Auswirkungen auf die letzte Seite eines Formulars.

Parameter

NameTypBeschreibung
valueStringden Wert der Auswahl, den die Befragten als Label sehen, wenn sie das Formular aufrufen
navigationTypePageNavigationTypeden Navigationstyp der Auswahl

Return

Choice – die neue Auswahlmöglichkeit

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 Argument response mit keiner gültigen Auswahl für dieses Element übereinstimmt.

Parameter

NameTypBeschreibung
responseStringeine gültige Antwort auf diesen Listeneintrag

Return

ItemResponse: die Elementantwort

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

duplicate()

Erstellt eine Kopie dieses Elements und hängt sie an das Ende des Formulars an.

Return

ListItem – ein Duplikat dieses ListItem für die Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getChoices()

Ruft alle Auswahlmöglichkeiten für ein Element ab.

Return

Choice[] – ein Array mit Auswahlmöglichkeiten

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getFeedbackForCorrect()

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

Return

QuizFeedback: das Feedback, falls vorhanden.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getFeedbackForIncorrect()

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

Return

QuizFeedback: das Feedback, falls vorhanden.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getHelpText()

den Hilfetext des Elements abrufen (manchmal als Beschreibungstext für Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet)

Return

String: Hilfe- oder Beschreibungstext des Elements

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getId()

Ruft die eindeutige ID des Artikels ab.

Return

Integer: ID des Artikels

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getIndex()

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

Return

Integer: der Index des Elements

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getPoints()

Gibt die Punktzahl eines benotbaren Elements zurück.

Return

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getTitle()

Ruft den Titel des Elements ab (im Fall eines SectionHeaderItem-Elements manchmal auch als Überschrifttext bezeichnet).

Return

String: Titel oder Überschriftentext des Elements

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getType()

Ruft den Typ des Elements ab, dargestellt als ItemType.

Return

ItemType: Typ des Elements

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

isRequired()

Legt fest, ob der Teilnehmer die Frage beantworten muss.

Return

Boolean: Gibt an, ob der Teilnehmer die Frage beantworten muss

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoiceValues(['Dogs', 'Cats']);

Parameter

NameTypBeschreibung
valuesString[]Array der Auswahlwerte, die die Befragten beim Aufrufen des Formulars als Labels sehen

Return

ListItem – dieses ListItem für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?')
item.setChoices([
    item.createChoice('Cats'),
    item.createChoice('Dogs')
]);

Parameter

NameTypBeschreibung
choicesChoice[]ein Array mit Auswahlmöglichkeiten

Return

ListItem – dieses ListItem für Verkettung

Löst aus

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setFeedbackForCorrect(feedback)

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

// Open a form by ID and add a new list item.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var 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.

Return

ListItem – dieses ListItem für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setFeedbackForIncorrect(feedback)

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

Parameter

NameTypBeschreibung
feedbackQuizFeedbackdas neue Feedback

Return

ListItem – dieses ListItem für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setHelpText(text)

Legt den Hilfetext des Elements fest. Bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems wird dieser Text manchmal auch als Beschreibungstext bezeichnet.

Parameter

NameTypBeschreibung
textStringdem neuen Hilfetext

Return

ListItem – dieses ListItem für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setPoints(points)

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

Parameter

NameTypBeschreibung
pointsIntegerdie Anzahl der Punkte, die eine Frage wert ist

Return

ListItem – dieses ListItem für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setRequired(enabled)

Legt fest, ob der Teilnehmer die Frage beantworten muss.

Parameter

NameTypBeschreibung
enabledBooleanob der Befragte die Frage beantworten muss

Return

ListItem: das aktuelle Element (zur Verkettung)

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setTitle(title)

Legt den Titel des Elements fest. Bei SectionHeaderItem wird dieser Text manchmal auch als Überschrifttext bezeichnet.

Parameter

NameTypBeschreibung
titleStringdem neuen Titel oder Text der Überschrift

Return

ListItem – dieses ListItem für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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