Class FormApp

FormularApp

Ermöglicht es einem Script, eine vorhandene Form zu öffnen oder eine neue zu erstellen.

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

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

Attribute

AttributTypBeschreibung
AlignmentAlignmentEine Aufzählung der Arten der Bildausrichtung.
DestinationTypeDestinationTypeEine Aufzählung der Zieltypen, in denen Formularantworten gespeichert werden können.
FeedbackTypeFeedbackTypeEine Aufzählung der Typen des Formulars Feedbacks.
ItemTypeItemTypeEine Aufzählung der Typen des Formulars Items.
PageNavigationTypePageNavigationTypeEine Aufzählung der möglichen Verhaltensweisen für die Navigation auf Seiten.
RatingIconTypeRatingIconTypeAufzählung der Arten von Altersfreigabesymbolen RatingIcons

Methoden

MethodeRückgabetypKurzbeschreibung
create(title)FormErstellt eine neue Form und gibt sie zurück.
createCheckboxGridValidation()CheckboxGridValidationBuilderGibt eine Instanz eines CheckboxGridValidationBuilder zurück, mit der die Validierung für eine CheckboxGridItem festgelegt werden kann.
createCheckboxValidation()CheckboxValidationBuilderGibt eine Instanz eines CheckboxValidationBuilder zurück, mit der die Validierung für eine CheckboxItem festgelegt werden kann.
createFeedback()QuizFeedbackBuilderGibt eine Instanz eines QuizFeedbackBuilder zurück, mit der Feedback zu einer benoteten Item festgelegt werden kann.
createGridValidation()GridValidationBuilderGibt eine Instanz eines GridValidationBuilder zurück, mit der die Validierung für eine GridItem festgelegt werden kann.
createParagraphTextValidation()ParagraphTextValidationBuilderGibt eine Instanz eines ParagraphTextValidationBuilder zurück, mit der die Validierung für einen ParagraphTextItem festgelegt werden kann.
createTextValidation()TextValidationBuilderGibt eine Instanz eines TextValidationBuilder zurück, mit der die Validierung für eine TextItem festgelegt werden kann.
getActiveForm()FormGibt das Formular zurück, an das das Script containergebunden ist.
getUi()UiGibt eine Instanz der Benutzeroberfläche des Formulareditors zurück, mit der dem Script Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzugefügt werden können.
openById(id)FormGibt die Form mit der angegebenen ID zurück.
openByUrl(url)FormGibt die Form mit der angegebenen URL zurück.

Detaillierte Dokumentation

create(title)

Erstellt eine neue Form und gibt sie 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
titleStringden Namen des neuen Formulars

Rückflug

Form – das neue Formular

Löst

Error – wenn der angegebene Titel null oder leer ist

Autorisierung

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

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

createCheckboxGridValidation()

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

Rückflug

CheckboxGridValidationBuilder


createCheckboxValidation()

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

Rückflug

CheckboxValidationBuilder


createFeedback()

Gibt eine Instanz eines QuizFeedbackBuilder zurück, mit der Feedback zu einer benoteten Item festgelegt werden kann.

Rückflug

QuizFeedbackBuilder


createGridValidation()

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

Rückflug

GridValidationBuilder


createParagraphTextValidation()

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

Rückflug

ParagraphTextValidationBuilder


createTextValidation()

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

Rückflug

TextValidationBuilder


getActiveForm()

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

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

Rückflug

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

getUi()

Gibt eine Instanz der Benutzeroberfläche des Formulareditors zurück, mit der dem Script Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzugefügt werden können. Ein Script kann nur mit der Benutzeroberfläche der aktuellen Instanz eines geöffneten Formulareditors (nicht der Ansicht, die ein Teilnehmer sieht) interagieren und nur, wenn das Script an das Formular gebunden ist. Weitere Informationen finden Sie in den Anleitungen 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();
}

Rückflug

Ui – eine Instanz der Benutzeroberfläche dieses Formulars


openById(id)

Gibt die 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ückflug

Form: das Formular mit der angegebenen ID

Löst

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

Autorisierung

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

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

openByUrl(url)

Gibt die 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ückflug

Form – das Formular mit der angegebenen URL

Löst

Error – wenn die angegebene URL ungültig ist oder der Nutzer nicht über ausreichende Berechtigungen verfügt

Autorisierung

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

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