Class FormApp

FormApp

Ermöglicht einem Skript, ein vorhandenes Form-Objekt 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 der Typen der Bildausrichtung.
DestinationTypeDestinationTypeEine Aufzählung von Zieltypen, die Formularantworten speichern können.
FeedbackTypeFeedbackTypeEine Aufzählung der Typen des Formulars Feedbacks.
ItemTypeItemTypeEine Aufzählung der Typen des Formulars Items.
PageNavigationTypePageNavigationTypeEine Aufzählung möglicher Verhaltensweisen beim Navigieren auf Seiten.

Methoden

MethodeRückgabetypKurzbeschreibung
create(title)FormErstellt ein neues Form-Objekt und gibt es zurück.
createCheckboxGridValidation()CheckboxGridValidationBuilderGibt eine Instanz eines CheckboxGridValidationBuilder zurück, mit dem die Validierung für ein CheckboxGridItem festgelegt werden kann.
createCheckboxValidation()CheckboxValidationBuilderGibt eine Instanz von CheckboxValidationBuilder zurück, mit der die Validierung für CheckboxItem festgelegt werden kann.
createFeedback()QuizFeedbackBuilderGibt eine Instanz eines QuizFeedbackBuilder zurück, mit dem Feedback zu einem benotbaren Item festgelegt werden kann.
createGridValidation()GridValidationBuilderGibt eine Instanz von GridValidationBuilder zurück, die verwendet werden kann, um die Validierung für einen GridItem festzulegen.
createParagraphTextValidation()ParagraphTextValidationBuilderGibt eine Instanz von ParagraphTextValidationBuilder zurück, mit der die Validierung für einen ParagraphTextItem festgelegt werden kann.
createTextValidation()TextValidationBuilderGibt eine Instanz von TextValidationBuilder zurück, die verwendet werden kann, um die Validierung für einen TextItem festzulegen.
getActiveForm()FormGibt das Formular zurück, in das das Skript containergebunden ist.
getUi()UiGibt eine Instanz der Benutzeroberfläche des Formulareditors zurück, mit der 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 das Form mit der angegebenen URL zurück.

Detaillierte Dokumentation

create(title)

Erstellt ein neues Form-Objekt 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
titleStringden Namen des neuen Formulars

Return

Form – das neue Formular

Löst aus

Error: Wenn der angegebene Titel null oder leer ist

Autorisierung

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

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

createCheckboxGridValidation()

Gibt eine Instanz eines CheckboxGridValidationBuilder zurück, mit dem die Validierung für ein CheckboxGridItem festgelegt werden kann.

Return

CheckboxGridValidationBuilder


createCheckboxValidation()

Gibt eine Instanz von CheckboxValidationBuilder zurück, mit der die Validierung für CheckboxItem festgelegt werden kann.

Return

CheckboxValidationBuilder


createFeedback()

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

Return

QuizFeedbackBuilder


createGridValidation()

Gibt eine Instanz von GridValidationBuilder zurück, die verwendet werden kann, um die Validierung für einen GridItem festzulegen.

Return

GridValidationBuilder


createParagraphTextValidation()

Gibt eine Instanz von ParagraphTextValidationBuilder zurück, mit der die Validierung für einen ParagraphTextItem festgelegt werden kann.

Return

ParagraphTextValidationBuilder


createTextValidation()

Gibt eine Instanz von TextValidationBuilder zurück, die verwendet werden kann, um die Validierung für einen TextItem festzulegen.

Return

TextValidationBuilder


getActiveForm()

Gibt das Formular zurück, in das das Skript containergebunden ist. Zur Interaktion mit Formularen, 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();

Return

Form – die Form, an die das Skript gebunden ist, oder null, wenn das Skript nicht an ein Formular gebunden 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

getUi()

Gibt eine Instanz der Benutzeroberfläche des Formulareditors zurück, mit der das Skript Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzufügen kann. Ein Skript kann nur für die aktuelle Instanz eines geöffneten Formulareditors mit der UI interagieren (nicht für die Ansicht, die der Teilnehmer sieht) und nur, wenn das Skript an das Formular gebunden ist. Weitere Informationen finden Sie in den Anleitungen zu Menüs sowie 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();
}

Return

Ui: Eine Instanz der Benutzeroberflächenumgebung 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 nicht berechtigt ist, das Formular zu öffnen.

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

Parameter

NameTypBeschreibung
idStringDie ID des zu öffnenden Formulars

Return

Form: das Formular mit der angegebenen ID

Löst aus

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

Autorisierung

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

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

openByUrl(url)

Gibt das 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
urlStringDie URL des Formulars, das geöffnet werden soll

Return

Form: das Formular mit der angegebenen URL

Löst aus

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

Autorisierung

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

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