Class FormApp

Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
FormApp

Ermöglicht einem Skript, ein vorhandenes Form zu öffnen oder ein neues zu erstellen.

// Open a form by ID.
var existingForm = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

// Create and open a form.
var newForm = FormApp.create('Form Name');

Attribute

PropertyTypBeschreibung
AlignmentAlignmentEine Aufzählung von Bildausrichtungstypen
DestinationTypeDestinationTypeEine Aufzählung von Zieltypen, die Formularantworten speichern können.
FeedbackTypeFeedbackTypeEine Aufzählung von Typen im Format Feedbacks.
ItemTypeItemTypeEine Aufzählung von Typen im Format Items.
PageNavigationTypePageNavigationTypeEine Aufzählung der möglichen Verhaltensweisen bei der Navigation auf Seiten.

Methoden

MethodeRückgabetypKurzbeschreibung
create(title)FormErstellt ein neues Form und gibt es zurück.
createCheckboxGridValidation()CheckboxGridValidationBuilderGibt eine Instanz eines CheckboxGridValidationBuilders zurück, mit dem eine Überprüfung der CheckboxGridItem festgelegt werden kann.
createCheckboxValidation()CheckboxValidationBuilderGibt eine Instanz eines CheckboxValidationBuilders zurück, mit dem eine Überprüfung der CheckboxItem festgelegt werden kann.
createFeedback()QuizFeedbackBuilderGibt eine Instanz von QuizFeedbackBuilder zurück, mit dem Feedback zu einem gradierbaren Item festgelegt werden kann.
createGridValidation()GridValidationBuilderGibt eine Instanz eines GridValidationBuilders zurück, mit dem eine Validierung für einen GridItem festgelegt werden kann.
createParagraphTextValidation()ParagraphTextValidationBuilderGibt eine Instanz eines ParagraphTextValidationBuilders zurück, mit dem eine Validierung für ein ParagraphTextItem festgelegt werden kann.
createTextValidation()TextValidationBuilderGibt eine Instanz eines TextValidationBuilders zurück, mit dem die Validierung für eine TextItem festgelegt werden kann.
getActiveForm()FormGibt das Formular zurück, an das das Skript containergebunden ist.
getUi()UiGibt eine Instanz der Benutzeroberfläche des Formulareditors zurück, über die das Skript Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzufügen kann.
openById(id)FormGibt das Form mit der angegebenen ID zurück.
openByUrl(url)FormGibt Form mit der angegebenen URL zurück.

Detaillierte Dokumentation

create(title)

Erstellt ein neues Form und gibt es zurück. Löst eine Ausnahme aus, wenn der angegebene Titel null oder leer ist

// Create and open a form.
var form = FormApp.create('Form Name');

Parameter

NameTypBeschreibung
titleStringName des neuen Formulars

Zurücksenden

Form: das neue Formular

Throws

Error – wenn der angegebene Titel null oder leer ist

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

createCheckboxGridValidation()

Gibt eine Instanz eines CheckboxGridValidationBuilders zurück, mit dem eine Überprüfung der CheckboxGridItem festgelegt werden kann.

Zurücksenden

CheckboxGridValidationBuilder


createCheckboxValidation()

Gibt eine Instanz eines CheckboxValidationBuilders zurück, mit dem eine Überprüfung der CheckboxItem festgelegt werden kann.

Zurücksenden

CheckboxValidationBuilder


createFeedback()

Gibt eine Instanz von QuizFeedbackBuilder zurück, mit dem Feedback zu einem gradierbaren Item festgelegt werden kann.

Zurücksenden

QuizFeedbackBuilder


createGridValidation()

Gibt eine Instanz eines GridValidationBuilders zurück, mit dem eine Validierung für einen GridItem festgelegt werden kann.

Zurücksenden

GridValidationBuilder


createParagraphTextValidation()

Gibt eine Instanz eines ParagraphTextValidationBuilders zurück, mit dem eine Validierung für ein ParagraphTextItem festgelegt werden kann.

Zurücksenden

ParagraphTextValidationBuilder


createTextValidation()

Gibt eine Instanz eines TextValidationBuilders zurück, mit dem die Validierung für eine TextItem festgelegt werden kann.

Zurücksenden

TextValidationBuilder


getActiveForm()

Gibt das Formular zurück, an das das Skript containergebunden ist. Wenn Sie mit Formularen interagieren möchten, an die das Skript nicht containergebunden ist, verwenden Sie stattdessen openById(id) oder openByUrl(url).

// Get the form to which this script is bound.
var form = FormApp.getActiveForm();

Zurücksenden

Form: das Formular, an das das Skript gebunden ist, oder null, wenn das Skript nicht an ein Formular gebunden ist

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getUi()

Gibt eine Instanz der Benutzeroberfläche des Formulareditors zurück, über die das Skript Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzufügen kann. Ein Skript kann nur mit der UI der aktuellen Instanz eines Editors für offene Formulare (nicht der Ansicht, die der Teilnehmer sieht) und nur dann interagieren, wenn das Skript an das Formular gebunden ist. Weitere Informationen finden Sie in den Leitfäden, unter anderem zu Menüs und Dialogfeldern und Seitenleisten.

// Add a custom menu to the active form, including a separator and a sub-menu.
function onOpen(e) {
  FormApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(FormApp.getUi().createMenu('My sub-menu')
          .addItem('One sub-menu item', 'mySecondFunction')
          .addItem('Another sub-menu item', 'myThirdFunction'))
      .addToUi();
}

Zurücksenden

Ui: Instanz der Benutzeroberflächen dieses Formulars


openById(id)

Gibt das Form mit der angegebenen ID zurück. Löst eine Ausnahme aus, wenn die ID ungültig ist oder der Nutzer keine Berechtigung zum Öffnen des Formulars hat.

// Open a form by ID.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

Parameter

NameTypBeschreibung
idStringID des zu öffnenden Formulars

Zurücksenden

Form: das Formular mit der angegebenen ID

Throws

Error: Wenn die angegebene ID ungültig ist oder der Nutzer nicht die erforderlichen Berechtigungen hat

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

openByUrl(url)

Gibt Form mit der angegebenen URL zurück. Löst eine Ausnahme aus, wenn die URL ungültig ist oder der Nutzer nicht berechtigt ist, das Formular zu öffnen.

// Open a form by URL.
var form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit'
    );

Parameter

NameTypBeschreibung
urlStringURL des zu öffnenden Formulars

Zurücksenden

Form: das Formular mit der angegebenen URL

Throws

Error: Wenn die angegebene URL ungültig ist oder der Nutzer nicht die erforderlichen Berechtigungen hat

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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