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 get
die Item
des Elements und wandeln Sie es dann mit einer Methode wie as
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
Name | Kurzbeschreibung |
---|
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
as | Checkbox | Gibt das Element als Kästchenrasterelement zurück. |
as | Checkbox | Gibt das Element als Kästchenelement zurück. |
as | Date | Gibt das Element als Datumselement zurück. |
as | Date | Gibt das Element als Datum/Uhrzeit zurück. |
as | Duration | Gibt den Artikel als Zeitelement zurück. |
as | Grid | Gibt den Artikel als Rasterelement zurück. |
as | Image | Gibt das Element als Bildelement zurück. |
as | List | Gibt das Element als Listenelement zurück. |
as | Multiple | Gibt das Element als Multiple-Choice-Element zurück. |
as | Page | Gibt das Element als Seitenumbruchelement zurück. |
as | Paragraph | Gibt das Element als Absatztext zurück. |
as | Rating | Gibt das Element als Bewertungselement zurück. |
as | Scale | Gibt das Element als Skalierungselement zurück. |
as | Section | Gibt das Element als Abschnittsheader zurück. |
as | Text | Gibt das Element als Textelement zurück. |
as | Time | Gibt den Artikel als Zeitelement zurück. |
as | Video | Gibt das Element als Videoelement zurück. |
duplicate() | Item | Erstellt eine Kopie dieses Elements und fügt sie am Ende des Formulars ein. |
get | String | Ruft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layoutelemente wie Image , Page und Section bezeichnet). |
get | Integer | Die eindeutige Kennung des Artikels. |
get | Integer | Ruft den Index des Elements unter allen Elementen im Formular ab. |
get | String | Der Titel des Artikels (im Fall eines Section auch als Headertext bezeichnet). |
get | Item | Der Typ des Artikels, dargestellt als Item . |
set | Item | Hiermit wird der Hilfetext des Elements festgelegt (bei Layoutelementen wie Image , Page und Section auch als Beschreibungstext bezeichnet). |
set | Item | Hiermit wird der Titel des Artikels festgelegt (im Fall eines Section auch als Headertext bezeichnet). |
Detaillierte Dokumentation
as Checkbox Grid Item()
Gibt das Element als Kästchenrasterelement zurück. Löst eine Scripting-Ausnahme aus, wenn die Item
nicht bereits CHECKBOX_GRID
war.
Rückflug
Checkbox
– 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
as Checkbox Item()
Gibt das Element als Kästchenelement zurück. Löst eine Scripting-Ausnahme aus, wenn die Item
nicht bereits CHECKBOX
war.
Rückflug
Checkbox
– 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
as Date Item()
Gibt das Element als Datumselement zurück. Löst eine Scripting-Ausnahme aus, wenn die Item
nicht bereits DATE
war.
Rückflug
Date
– 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
as Date Time Item()
Gibt das Element als Datum/Uhrzeit zurück. Löst eine Scripting-Ausnahme aus, wenn die Item
nicht bereits DATETIME
war.
Rückflug
Date
– 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
as Duration Item()
Gibt den Artikel als Zeitelement zurück. Löst eine Scripting-Ausnahme aus, wenn die Item
nicht bereits DURATION
war.
Rückflug
Duration
– 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
as Grid Item()
Gibt den Artikel als Rasterelement zurück. Löst eine Scripting-Ausnahme aus, wenn die Item
nicht bereits GRID
war.
Rückflug
Grid
– 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
as Image Item()
as List Item()
Gibt das Element als Listenelement zurück. Löst eine Scripting-Ausnahme aus, wenn die Item
nicht bereits LIST
war.
Rückflug
List
– 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
as Multiple Choice Item()
Gibt das Element als Multiple-Choice-Element zurück. Löst eine Scripting-Ausnahme aus, wenn die Item
nicht bereits MULTIPLE_CHOICE
war.
Rückflug
Multiple
– 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
as Page Break Item()
Gibt das Element als Seitenumbruchelement zurück. Löst eine Scripting-Ausnahme aus, wenn die Item
nicht bereits PAGE_BREAK
war.
Rückflug
Page
– 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
as Paragraph Text Item()
Gibt das Element als Absatztext zurück. Löst eine Scripting-Ausnahme aus, wenn die Item
nicht bereits PARAGRAPH_TEXT
war.
Rückflug
Paragraph
– 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
as Rating Item()
Gibt das Element als Bewertungselement zurück. Eine ScriptingException wird geworfen, wenn Item
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
Rating
: 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
as Scale Item()
Gibt das Element als Skalierungselement zurück. Löst eine Scripting-Ausnahme aus, wenn die Item
nicht bereits SCALE
war.
Rückflug
Scale
– 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
as Section Header Item()
Gibt das Element als Abschnittsheader zurück. Löst eine Scripting-Ausnahme aus, wenn die Item
nicht bereits SECTION_HEADER
war.
Rückflug
Section
– 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
as Text Item()
Gibt das Element als Textelement zurück. Löst eine Scripting-Ausnahme aus, wenn die Item
nicht bereits TEXT
war.
Rückflug
Text
– 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
as Time Item()
Gibt den Artikel als Zeitelement zurück. Löst eine Scripting-Ausnahme aus, wenn die Item
nicht bereits TIME
war.
Rückflug
Time
– 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
as Video Item()
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
get Help Text()
Ruft den Hilfetext des Elements ab (manchmal auch als Beschreibungstext für Layoutelemente wie Image
, Page
und Section
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
get Id()
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
get Index()
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
get Title()
Der Titel des Artikels (im Fall eines Section
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
get Type()
Der Typ des Artikels, dargestellt als Item
.
Rückflug
Item
: 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
set Help Text(text)
Hiermit wird der Hilfetext des Elements festgelegt (bei Layoutelementen wie Image
, Page
und Section
auch als Beschreibungstext bezeichnet).
Parameter
Name | Typ | Beschreibung |
---|---|---|
text | String | den 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
set Title(title)
Hiermit wird der Titel des Artikels festgelegt (im Fall eines Section
auch als Headertext bezeichnet).
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | den 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