Interface Item

Posten

Ein generisches Formularelement, das Eigenschaften enthält, die allen Elementen gemeinsam sind, z. B. Titel und Hilfetext. Auf Elemente kann über eine Form zugegriffen oder sie können über eine Form erstellt werden.

Wenn Sie typenspezifische Attribute verwenden möchten, prüfen Sie mit getType() die ItemType des Elements und wandeln Sie das Element dann mit einer Methode wie asCheckboxItem() in die entsprechende Klasse um. 

// Create a new form and add a text item.
const form = FormApp.create('Form Name');
form.addTextItem();

// Access the text item as a generic item.
const items = form.getItems();
const item = items[0];

// Cast the generic item to the text-item class.
if (item.getType() === 'TEXT') {
  const textItem = item.asTextItem();
  textItem.setRequired(false);
}

Klassen implementieren

NameKurzbeschreibung

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

Detaillierte Dokumentation

asCheckboxGridItem()

Gibt das Element als Checkbox-Rasterelement zurück. Löst eine Scripting-Ausnahme aus, wenn ItemType nicht bereits CHECKBOX_GRID war.

Rückflug

CheckboxGridItem: Das Kästchenraster-Element

Löst

Error: Das Element ist kein Kontrollkästchenrasterelement.

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

asCheckboxItem()

Gibt das Element als Checkbox-Element zurück. Löst eine Scripting-Ausnahme aus, wenn ItemType nicht bereits CHECKBOX war.

Rückflug

CheckboxItem – das Kästchen-Element

Löst

Error: wenn das Element kein Kontrollkästchen 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

asDateItem()

Gibt das Element als Datumselement zurück. Löst eine Scripting-Ausnahme aus, wenn ItemType nicht bereits DATE war.

Rückflug

DateItem – das Datumselement

Löst

Error – wenn das Element kein Datumselement 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

asDateTimeItem()

Gibt das Element als Datum/Uhrzeit-Element zurück. Löst eine Scripting-Ausnahme aus, wenn ItemType nicht bereits DATETIME war.

Rückflug

DateTimeItem – das Datum/Uhrzeit-Element

Löst

Error: wenn das Element kein Datum/Uhrzeit-Element 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

asDurationItem()

Gibt das Element als Dauer-Element zurück. Löst eine Scripting-Ausnahme aus, wenn ItemType nicht bereits DURATION war.

Rückflug

DurationItem – das Dauer-Element

Löst

Error: wenn es sich beim Artikel nicht um einen Artikel mit Dauer handelt

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

asGridItem()

Gibt das Element als Rasterelement zurück. Löst eine Scripting-Ausnahme aus, wenn ItemType nicht bereits GRID war.

Rückflug

GridItem: Das Rasterelement

Löst

Error: wenn das Element kein Rasterelement 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

asImageItem()

Gibt das Element als Bild zurück. Löst eine Scripting-Ausnahme aus, wenn ItemType nicht bereits IMAGE war.

Rückflug

ImageItem – das Bildelement

Löst

Error – wenn es sich beim Element nicht um ein Bildelement handelt

asListItem()

Gibt das Element als Listenelement zurück. Löst eine Scripting-Ausnahme aus, wenn ItemType nicht bereits LIST war.

Rückflug

ListItem: das Listenelement

Löst

Error – wenn das Element kein Listenelement 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

asMultipleChoiceItem()

Gibt das Element als Multiple-Choice-Element zurück. Löst eine Scripting-Ausnahme aus, wenn ItemType nicht bereits MULTIPLE_CHOICE war.

Rückflug

MultipleChoiceItem: die Multiple-Choice-Antwort

Löst

Error: Wenn es sich nicht um eine Multiple-Choice-Frage handelt

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

asPageBreakItem()

Gibt das Element als Seitenumbruch-Element zurück. Löst eine Scripting-Ausnahme aus, wenn ItemType nicht bereits PAGE_BREAK war.

Rückflug

PageBreakItem – das Seitenumbruch-Element

Löst

Error: Wenn das Element kein Seitenumbruchelement 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

asParagraphTextItem()

Gibt das Element als Absatztextelement zurück. Löst eine Scripting-Ausnahme aus, wenn ItemType nicht bereits PARAGRAPH_TEXT war.

Rückflug

ParagraphTextItem – das Absatztextelement

Löst

Error: Wenn das Element kein Absatztextelement 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

asRatingItem()

Gibt das Element als Bewertungselement zurück. Löst eine ScriptingException aus, wenn ItemType nicht bereits RATING war. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Fetch any item which is of type rating.
const item = form.getItems(FormApp.ItemType.RATING)[0];

// Convert the item to a rating item.
const ratingItem = item.asRatingItem();

Rückflug

RatingItem: Das Bewertungselement.

Löst

Error – wenn das Element kein Bewertungselement 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

asScaleItem()

Gibt das Element als Skalenelement zurück. Löst eine Scripting-Ausnahme aus, wenn ItemType nicht bereits SCALE war.

Rückflug

ScaleItem – das Skalierungselement

Löst

Error: Das Element ist kein Skalenelement.

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

asSectionHeaderItem()

Gibt das Element als Abschnittsüberschrift zurück. Löst eine Scripting-Ausnahme aus, wenn ItemType nicht bereits SECTION_HEADER war.

Rückflug

SectionHeaderItem – das Element für die Abschnittsüberschrift

Löst

Error – wenn das Element kein Abschnittsüberschriftenelement 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

asTextItem()

Gibt das Element als Textelement zurück. Löst eine Scripting-Ausnahme aus, wenn ItemType nicht bereits TEXT war.

Rückflug

TextItem – das Textelement

Löst

Error – wenn das Element kein Textelement 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

asTimeItem()

Gibt das Element als Zeitelement zurück. Löst eine Scripting-Ausnahme aus, wenn ItemType nicht bereits TIME war.

Rückflug

TimeItem: Das Zeitelement

Löst

Error – wenn das Element kein Zeitelement 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

asVideoItem()

Gibt das Element als Videoelement zurück. Löst eine Scripting-Ausnahme aus, wenn ItemType nicht bereits VIDEO war.

Rückflug

VideoItem – das Videoelement

Löst

Error – wenn das Element kein Video ist

duplicate()

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

Rückflug

Item – ein Duplikat dieses Item 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

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

getTitle()

Ruft den Titel des Elements ab (bei einem SectionHeaderItem manchmal auch als Header-Text 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

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

Item – diese Item 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

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

Item – diese Item 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