Class FormApp

FormApp

Consente a uno script di aprire un elemento Form esistente o di crearne uno nuovo.

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

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

Proprietà

ProprietàTipoDescrizione
AlignmentAlignmentUn'enumerazione dei tipi di allineamento dell'immagine.
DestinationTypeDestinationTypeUn'enumerazione dei tipi di destinazioni che possono archiviare le risposte del modulo.
FeedbackTypeFeedbackTypeUn'enumerazione dei tipi di modulo Feedbacks.
ItemTypeItemTypeUn'enumerazione dei tipi di modulo Items.
PageNavigationTypePageNavigationTypeUn'enumerazione dei possibili comportamenti della navigazione nelle pagine.

Metodi

MetodoTipo restituitoBreve descrizione
create(title)FormCrea e restituisce un nuovo Form.
createCheckboxGridValidation()CheckboxGridValidationBuilderRestituisce un'istanza di CheckboxGridValidationBuilder che può essere utilizzata per impostare la convalida in un CheckboxGridItem.
createCheckboxValidation()CheckboxValidationBuilderRestituisce un'istanza di CheckboxValidationBuilder che può essere utilizzata per impostare la convalida in un CheckboxItem.
createFeedback()QuizFeedbackBuilderRestituisce un'istanza di QuizFeedbackBuilder che può essere utilizzata per impostare un feedback su un elemento Item valutabile.
createGridValidation()GridValidationBuilderRestituisce un'istanza di GridValidationBuilder che può essere utilizzata per impostare la convalida su un GridItem.
createParagraphTextValidation()ParagraphTextValidationBuilderRestituisce un'istanza di un oggetto ParagraphTextValidationBuilder che può essere utilizzata per impostare la convalida su un oggetto ParagraphTextItem.
createTextValidation()TextValidationBuilderRestituisce un'istanza di TextValidationBuilder che può essere utilizzata per impostare la convalida su un TextItem.
getActiveForm()FormRestituisce il modulo a cui lo script è collegato al container.
getUi()UiRestituisce un'istanza dell'ambiente dell'interfaccia utente dell'editor del modulo che consente allo script di aggiungere funzionalità come menu, finestre di dialogo e barre laterali.
openById(id)FormRestituisce Form con l'ID specificato.
openByUrl(url)FormRestituisce Form con l'URL specificato.

Documentazione dettagliata

create(title)

Crea e restituisce un nuovo Form. Genera un'eccezione se il titolo specificato è null o vuoto.

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

Parametri

NomeTipoDescrizione
titleStringil nome del nuovo modulo

Ritorni

Form: il nuovo modulo

Tiri

Error: se il titolo specificato è null o vuoto

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

createCheckboxGridValidation()

Restituisce un'istanza di CheckboxGridValidationBuilder che può essere utilizzata per impostare la convalida in un CheckboxGridItem.

Ritorni

CheckboxGridValidationBuilder


createCheckboxValidation()

Restituisce un'istanza di CheckboxValidationBuilder che può essere utilizzata per impostare la convalida in un CheckboxItem.

Ritorni

CheckboxValidationBuilder


createFeedback()

Restituisce un'istanza di QuizFeedbackBuilder che può essere utilizzata per impostare un feedback su un elemento Item valutabile.

Ritorni

QuizFeedbackBuilder


createGridValidation()

Restituisce un'istanza di GridValidationBuilder che può essere utilizzata per impostare la convalida su un GridItem.

Ritorni

GridValidationBuilder


createParagraphTextValidation()

Restituisce un'istanza di un oggetto ParagraphTextValidationBuilder che può essere utilizzata per impostare la convalida su un oggetto ParagraphTextItem.

Ritorni

ParagraphTextValidationBuilder


createTextValidation()

Restituisce un'istanza di TextValidationBuilder che può essere utilizzata per impostare la convalida su un TextItem.

Ritorni

TextValidationBuilder


getActiveForm()

Restituisce il modulo a cui lo script è collegato al container. Per interagire con i moduli a cui lo script non è vincolato a un container, utilizza invece openById(id) o openByUrl(url).

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

Ritorni

Form: il modulo a cui è associato lo script oppure null se lo script non è associato a un modulo

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getUi()

Restituisce un'istanza dell'ambiente dell'interfaccia utente dell'editor del modulo che consente allo script di aggiungere funzionalità come menu, finestre di dialogo e barre laterali. Uno script può interagire con l'interfaccia utente solo per l'istanza corrente di un editor di moduli aperto (non per la visualizzazione visualizzata da un intervistato) e solo se lo script è associato al modulo. Per ulteriori informazioni, consulta le guide ai menu e alle finestre di dialogo e barre laterali.

// 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();
}

Ritorni

Ui: un'istanza dell'ambiente dell'interfaccia utente di questo modulo


openById(id)

Restituisce Form con l'ID specificato. Genera un'eccezione se l'ID non è valido o se l'utente non dispone dell'autorizzazione per aprire il modulo.

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

Parametri

NomeTipoDescrizione
idStringl'ID del modulo da aprire

Ritorni

Form: il modulo con l'ID specificato

Tiri

Error: se l'ID specificato non è valido o l'utente non dispone di autorizzazioni sufficienti

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

openByUrl(url)

Restituisce Form con l'URL specificato. Genera un'eccezione se l'URL non è valido o se l'utente non dispone dell'autorizzazione per aprire il modulo.

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

Parametri

NomeTipoDescrizione
urlStringl'URL del modulo da aprire

Ritorni

Form: il modulo con l'URL specificato

Tiri

Error: se l'URL specificato non è valido o l'utente non dispone di autorizzazioni sufficienti

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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