Class FormApp

FormApp

Ermöglicht einem Script, 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

AttributTypBeschreibung
AlignmentAlignmentEine Aufzählung der Arten der Bildausrichtung.
DestinationTypeDestinationTypeEine Aufzählung von Zieltypen, in denen Formularantworten gespeichert werden können.
FeedbackTypeFeedbackTypeEine Aufzählung der Typen des Formats Feedbacks.
ItemTypeItemTypeEine Aufzählung der Typen des Formats Items.
PageNavigationTypePageNavigationTypeEine Aufzählung der möglichen Verhaltensweisen beim Navigieren auf Seiten.

Methoden

MethodeRückgabetypKurzbeschreibung
create(title)FormErstellt einen neuen Form und gibt ihn zurück.
createCheckboxGridValidation()CheckboxGridValidationBuilderGibt eine Instanz eines CheckboxGridValidationBuilder zurück, mit dem die Validierung für ein festgelegt werden kann. CheckboxGridItem
createCheckboxValidation()CheckboxValidationBuilderGibt eine Instanz eines CheckboxValidationBuilder zurück, mit dem die Validierung für ein festgelegt werden kann. CheckboxItem
createFeedback()QuizFeedbackBuilderGibt eine Instanz von QuizFeedbackBuilder zurück, mit dem Feedback zu einer benotbaren Item
createGridValidation()GridValidationBuilderGibt eine Instanz von GridValidationBuilder zurück, mit der eine Validierung für ein GridItem festgelegt werden kann.
createParagraphTextValidation()ParagraphTextValidationBuilderGibt eine Instanz eines ParagraphTextValidationBuilder zurück, mit dem die Validierung für festgelegt werden kann. ein ParagraphTextItem.
createTextValidation()TextValidationBuilderGibt eine Instanz von TextValidationBuilder zurück, mit dem eine 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.
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 einen neuen Form und gibt ihn zurück. Löst eine Ausnahme aus, wenn der angegebene Titel null ist oder leer ist.

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

Parameter

NameTypBeschreibung
titleStringden Namen des neuen Formulars

Rückflug

Form – das neue Formular

Löst aus

Error – wenn der angegebene Titel null ist 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 festgelegt werden kann. CheckboxGridItem

Rückflug

CheckboxGridValidationBuilder


createCheckboxValidation()

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

Rückflug

CheckboxValidationBuilder


createFeedback()

Gibt eine Instanz von QuizFeedbackBuilder zurück, mit dem Feedback zu einer benotbaren Item

Rückflug

QuizFeedbackBuilder


createGridValidation()

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

Rückflug

GridValidationBuilder


createParagraphTextValidation()

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

Rückflug

ParagraphTextValidationBuilder


createTextValidation()

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

Rückflug

TextValidationBuilder


getActiveForm()

Gibt das Formular zurück, an das das Skript containergebunden ist. Um mit Formularen zu interagieren, Skript ist nicht containergebunden, verwenden Sie openById(id) oder openByUrl(url) .

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

Rückflug

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

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ächenumgebung des Formulareditors zurück, mit der das Skript Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzufügen. Ein Skript kann nur mit der UI für den aktuelle Instanz eines geöffneten Formulareditors (nicht die Ansicht, die der Befragte sieht) und nur, wenn die 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ä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 Der Nutzer ist nicht berechtigt, das Formular zu öffnen.

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

Parameter

NameTypBeschreibung
idStringID des zu öffnenden Formulars

Rückflug

Form – Das Formular mit der angegebenen ID

Löst aus

Error – wenn die angegebene ID ungültig ist oder der Nutzer nicht genügend Berechtigungen

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 oder Der Nutzer ist nicht berechtigt, 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 zu öffnenden Formulars

Rückflug

Form – das Formular mit der angegebenen URL

Löst aus

Error – wenn die angegebene URL ungültig ist oder der Nutzer nicht genügend Berechtigungen

Autorisierung

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

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