Class FormApp

FormApp

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

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

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

Proprietà

ProprietàTipoDescrizione
AlignmentAlignmentUn'enumerazione dei tipi di allineamento delle immagini.
DestinationTypeDestinationTypeUn'enumerazione dei tipi di destinazioni che possono archiviare le risposte ai moduli.
FeedbackTypeFeedbackTypeUn'enumerazione dei tipi di Feedbacks dei moduli.
ItemTypeItemTypeUn'enumerazione dei tipi di Items dei moduli.
PageNavigationTypePageNavigationTypeUn'enumerazione dei possibili comportamenti per la navigazione tra le pagine.
RatingIconTypeRatingIconTypeUn'enumerazione dei tipi di icone di valutazione RatingIcons.

Metodi

MetodoTipo restituitoBreve descrizione
create(title)FormCrea e restituisce un nuovo Form.
create(title, isPublished)FormCrea e restituisce un nuovo Form nello stato di pubblicazione richiesto.
createCheckboxGridValidation()CheckboxGridValidationBuilderRestituisce un'istanza di CheckboxGridValidationBuilder che può essere utilizzata per impostare la convalida su un CheckboxGridItem.
createCheckboxValidation()CheckboxValidationBuilderRestituisce un'istanza di CheckboxValidationBuilder che può essere utilizzata per impostare la convalida su un CheckboxItem.
createFeedback()QuizFeedbackBuilderRestituisce un'istanza di QuizFeedbackBuilder che può essere utilizzata per impostare il feedback su un Item valutabile.
createGridValidation()GridValidationBuilderRestituisce un'istanza di GridValidationBuilder che può essere utilizzata per impostare la convalida su un GridItem.
createParagraphTextValidation()ParagraphTextValidationBuilderRestituisce un'istanza di ParagraphTextValidationBuilder che può essere utilizzata per impostare la convalida su un ParagraphTextItem.
createTextValidation()TextValidationBuilderRestituisce un'istanza di TextValidationBuilder che può essere utilizzata per impostare la convalida su un TextItem.
getActiveForm()FormRestituisce il modulo a cui è associato lo script.
getUi()UiRestituisce un'istanza dell'ambiente dell'interfaccia utente dell'editor di moduli che consente allo script di aggiungere funzionalità come menu, finestre di dialogo e barre laterali.
openById(id)FormRestituisce il Form con l'ID specificato.
openByUrl(url)FormRestituisce il 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.
const form = FormApp.create('Form Name');

Parametri

NomeTipoDescrizione
titleStringIl nome del nuovo modulo.

Indietro

Form : il nuovo modulo.

Genera

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

create(title, isPublished)

Crea e restituisce un nuovo Form nello stato di pubblicazione richiesto. Genera un'eccezione se il titolo specificato è null o vuoto. 

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

Parametri

NomeTipoDescrizione
titleStringIl nome del nuovo modulo.
isPublishedBooleanIndica se il modulo deve essere pubblicato.

Indietro

Form : il nuovo modulo.

Genera

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 su un CheckboxGridItem.

Indietro

CheckboxGridValidationBuilder

createCheckboxValidation()

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

Indietro

CheckboxValidationBuilder

createFeedback()

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

Indietro

QuizFeedbackBuilder

createGridValidation()

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

Indietro

GridValidationBuilder

createParagraphTextValidation()

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

Indietro

ParagraphTextValidationBuilder

createTextValidation()

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

Indietro

TextValidationBuilder

getActiveForm()

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

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

Indietro

Form : il modulo a cui è associato lo script o 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 di moduli 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 la visualizzazione che vede un rispondente) e solo se lo script è associato al modulo. Per ulteriori informazioni, consulta le guide a menu e 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();
}

Indietro

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

openById(id)

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

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

Parametri

NomeTipoDescrizione
idStringL'ID del modulo da aprire

Indietro

Form : il modulo con l'ID specificato

Genera

Error : se l'ID specificato non è valido o se l'utente non dispone delle 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 il Form con l'URL specificato. Genera un'eccezione se l'URL non è valido o se l'utente non ha l'autorizzazione per aprire il modulo. 

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

Parametri

NomeTipoDescrizione
urlStringL'URL del modulo da aprire

Indietro

Form : il modulo con l'URL specificato

Genera

Error : se l'URL specificato non è valido o se l'utente non dispone delle 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