Class FormApp

FormApp

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

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

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

Properties

AttributTypBeschreibung
AlignmentAlignmentEine Aufzählung der Typen der Bildausrichtung.
DestinationTypeDestinationTypeEine Aufzählung der Typen von Zielen, in denen Formularantworten gespeichert werden können.
FeedbackTypeFeedbackTypeEine Aufzählung der Typen von Feedbacks für Formulare.
ItemTypeItemTypeEine Aufzählung der Typen von Items für Formulare.
PageNavigationTypePageNavigationTypeEine Aufzählung der möglichen Verhaltensweisen für die Navigation auf Seiten.
RatingIconTypeRatingIconTypeEine Aufzählung der Bewertungssymboltypen RatingIcons

Methoden

MethodeRückgabetypKurzbeschreibung
create(title)FormErstellt ein neues Form und gibt es zurück.
create(title, isPublished)FormErstellt ein neues Form im angeforderten Veröffentlichungsstatus und gibt es zurück.
createCheckboxGridValidation()CheckboxGridValidationBuilderGibt eine Instanz von CheckboxGridValidationBuilder zurück, mit der die Validierung für ein CheckboxGridItem festgelegt werden kann.
createCheckboxValidation()CheckboxValidationBuilderGibt eine Instanz von CheckboxValidationBuilder zurück, mit der die Validierung für ein CheckboxItem festgelegt werden kann.
createFeedback()QuizFeedbackBuilderGibt eine Instanz von QuizFeedbackBuilder zurück, mit der Feedback für ein bewertbares Item festgelegt werden kann.
createGridValidation()GridValidationBuilderGibt eine Instanz von GridValidationBuilder zurück, mit der die Validierung für ein GridItem festgelegt werden kann.
createParagraphTextValidation()ParagraphTextValidationBuilderGibt eine Instanz von ParagraphTextValidationBuilder zurück, mit der die Validierung für ein ParagraphTextItemfestgelegt werden kann.
createTextValidation()TextValidationBuilderGibt eine Instanz von TextValidationBuilder zurück, mit der die Validierung für ein TextItem festgelegt werden kann.
getActiveForm()FormGibt das Formular zurück, an das das Skript containergebunden ist.
getUi()UiGibt eine Instanz der Benutzeroberflächenumgebung 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 und gibt es zurück. Löst eine Ausnahme aus, wenn der angegebene Titel null oder leer ist. 

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

Parameter

NameTypBeschreibung
titleStringDer Name des neuen Formulars.

Rückgabe

Form – Das neue Formular.

Löst

Error – wenn der angegebene Titel null oder leer ist

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

create(title, isPublished)

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

// Create, publish and open a form.
const form = FormApp.create('Form Name', true);

Parameter

NameTypBeschreibung
titleStringDer Name des neuen Formulars.
isPublishedBooleanGibt an, ob das Formular veröffentlicht werden soll.

Rückgabe

Form – Das neue Formular.

Löst

Error – wenn der angegebene Titel null oder leer ist

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

createCheckboxGridValidation()

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

Rückgabe

CheckboxGridValidationBuilder

createCheckboxValidation()

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

Rückgabe

CheckboxValidationBuilder

createFeedback()

Gibt eine Instanz von QuizFeedbackBuilder zurück, mit der Feedback für ein bewertbares Item festgelegt werden kann.

Rückgabe

QuizFeedbackBuilder

createGridValidation()

Gibt eine Instanz von GridValidationBuilder zurück, mit der die Validierung für ein GridItem festgelegt werden kann.

Rückgabe

GridValidationBuilder

createParagraphTextValidation()

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

Rückgabe

ParagraphTextValidationBuilder

createTextValidation()

Gibt eine Instanz von TextValidationBuilder zurück, mit der die Validierung für ein TextItem festgelegt werden kann.

Rückgabe

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.
const form = FormApp.getActiveForm();

Rückgabe

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

getUi()

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

Rückgabe

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 keine Berechtigung zum Öffnen des Formulars hat. 

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

Parameter

NameTypBeschreibung
idStringDie ID des zu öffnenden Formulars

Rückgabe

Form – das Formular mit der angegebenen ID

Löst

Error – wenn die angegebene ID ungültig ist oder der Nutzer nicht die erforderlichen Berechtigungen hat

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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 keine Berechtigung zum Öffnen des Formulars hat. 

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

Parameter

NameTypBeschreibung
urlStringDie URL des zu öffnenden Formulars

Rückgabe

Form – das Formular mit der angegebenen URL

Löst

Error – wenn die angegebene URL ungültig ist oder der Nutzer nicht die erforderlichen Berechtigungen hat

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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