Interface Item

Posten

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

Wenn Sie mit typspezifischen Properties arbeiten möchten, prüfen Sie mit getType() die ItemType des Elements und wandeln Sie es 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 Kästchenrasterelement zurück.
asCheckboxItem()CheckboxItemGibt das Element als Kästchenelement zurück.
asDateItem()DateItemGibt das Element als Datumselement zurück.
asDateTimeItem()DateTimeItemGibt das Element als Datum/Uhrzeit zurück.
asDurationItem()DurationItemGibt den Artikel als Zeitelement zurück.
asGridItem()GridItemGibt den Artikel als Rasterelement zurück.
asImageItem()ImageItemGibt das Element als Bildelement zurück.
asListItem()ListItemGibt das Element als Listenelement zurück.
asMultipleChoiceItem()MultipleChoiceItemGibt das Element als Multiple-Choice-Element zurück.
asPageBreakItem()PageBreakItemGibt das Element als Seitenumbruchelement zurück.
asParagraphTextItem()ParagraphTextItemGibt das Element als Absatztext zurück.
asRatingItem()RatingItemGibt das Element als Bewertungselement zurück.
asScaleItem()ScaleItemGibt das Element als Skalierungselement zurück.
asSectionHeaderItem()SectionHeaderItemGibt das Element als Abschnittsheader zurück.
asTextItem()TextItemGibt das Element als Textelement zurück.
asTimeItem()TimeItemGibt den Artikel 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 Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).
getId()IntegerDie eindeutige Kennung des Artikels.
getIndex()IntegerRuft den Index des Elements unter allen Elementen im Formular ab.
getTitle()StringDer Titel des Artikels (im Fall eines SectionHeaderItem auch als Headertext bezeichnet).
getType()ItemTypeDer Typ des Artikels, dargestellt als ItemType.
setHelpText(text)ItemHiermit wird der Hilfetext des Elements festgelegt (bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems auch als Beschreibungstext bezeichnet).
setTitle(title)ItemHiermit wird der Titel des Artikels festgelegt (im Fall eines SectionHeaderItem auch als Headertext bezeichnet).

Detaillierte Dokumentation

asCheckboxGridItem()

Gibt das Element als Kästchenrasterelement zurück. Löst eine Scripting-Ausnahme aus, wenn die ItemType nicht bereits CHECKBOX_GRID war.

Rückflug

CheckboxGridItem – das Kästchenrasterelement

Löst

Error, wenn das Element kein Kästchenrasterelement ist

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

asCheckboxItem()

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

Rückflug

CheckboxItem – das Kästchen-Element

Löst

Error, wenn es sich nicht um ein Kästchenelement handelt

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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 die ItemType nicht bereits DATE war.

Rückflug

DateItem – das Datum

Löst

Error, wenn es sich nicht um ein Datumselement handelt

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

asDateTimeItem()

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

Rückflug

DateTimeItem – das Datum/Uhrzeit-Element

Löst

Error – wenn es sich nicht um ein Datum/Uhrzeit-Element handelt

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

asDurationItem()

Gibt den Artikel als Zeitelement zurück. Löst eine Scripting-Ausnahme aus, wenn die ItemType nicht bereits DURATION war.

Rückflug

DurationItem – das Element „Dauer“

Löst

Error – wenn es sich nicht um einen Artikel mit einer Dauer handelt

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

asGridItem()

Gibt den Artikel als Rasterelement zurück. Löst eine Scripting-Ausnahme aus, wenn die 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

asImageItem()

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

Rückflug

ImageItem – das Bildelement

Löst

Error, wenn es sich nicht um ein Bildelement handelt


asListItem()

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

Rückflug

ListItem – der Listeneintrag

Löst

Error – wenn es sich nicht um ein Listenelement handelt

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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 die ItemType nicht bereits MULTIPLE_CHOICE war.

Rückflug

MultipleChoiceItem – die Multiple-Choice-Option

Löst

Error, wenn es sich nicht um ein Multiple-Choice-Element handelt

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

asPageBreakItem()

Gibt das Element als Seitenumbruchelement zurück. Löst eine Scripting-Ausnahme aus, wenn die 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

asParagraphTextItem()

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

Rückflug

ParagraphTextItem – das Textelement für Absätze

Löst

Error – wenn das Element kein Absatztextelement ist

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

asRatingItem()

Gibt das Element als Bewertungselement zurück. Eine ScriptingException wird geworfen, wenn ItemType noch nicht 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 es sich nicht um einen Bewertungsartikel handelt

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

asScaleItem()

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

Rückflug

ScaleItem – das Skalierungselement

Löst

Error, wenn der Artikel kein Artikel mit Maßstab ist

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

asSectionHeaderItem()

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

Rückflug

SectionHeaderItem – das Element „section-header“

Löst

Error, wenn es sich nicht um ein Bereichsheader-Element handelt

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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 die ItemType nicht bereits TEXT war.

Rückflug

TextItem – das Textelement

Löst

Error: Das Element ist kein Textelement.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

asTimeItem()

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

Rückflug

TimeItem – das Zeitelement

Löst

Error – wenn es sich nicht um einen Zeitelement handelt

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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 die ItemType nicht bereits VIDEO war.

Rückflug

VideoItem – das Videoelement

Löst

Error – wenn es sich nicht um ein Videoelement handelt


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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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 Layoutelemente wie ImageItems, PageBreakItems und SectionHeaderItems bezeichnet).

Rückflug

String: Hilfetext oder Beschreibung des Artikels

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getId()

Die eindeutige Kennung des Artikels.

Rückflug

Integer: die Artikel-ID

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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 Artikels

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getTitle()

Der Titel des Artikels (im Fall eines SectionHeaderItem auch als Headertext bezeichnet).

Rückflug

String – Titel oder Headertext des Artikels

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getType()

Der Typ des Artikels, dargestellt als ItemType.

Rückflug

ItemType: Der Typ des Artikels.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setHelpText(text)

Hiermit wird der Hilfetext des Elements festgelegt (bei Layoutelementen wie ImageItems, PageBreakItems und SectionHeaderItems auch als Beschreibungstext bezeichnet).

Parameter

NameTypBeschreibung
textStringden neuen Hilfetext

Rückflug

Item – dieses Item für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setTitle(title)

Hiermit wird der Titel des Artikels festgelegt (im Fall eines SectionHeaderItem auch als Headertext bezeichnet).

Parameter

NameTypBeschreibung
titleStringden neuen Titel oder Headertext

Rückflug

Item – dieses Item für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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