Class FormApp

FormApp

Permet à un script d'ouvrir un Form existant ou d'en créer un. 

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

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

Propriétés

PropriétéTypeDescription
AlignmentAlignmentÉnumération des types d'alignement d'image.
DestinationTypeDestinationTypeÉnumération des types de destinations pouvant stocker les réponses au formulaire.
FeedbackTypeFeedbackTypeÉnumération des types de Feedbacks de formulaire.
ItemTypeItemTypeÉnumération des types d'Items de formulaire.
PageNavigationTypePageNavigationTypeÉnumération des comportements possibles pour la navigation entre les pages.
RatingIconTypeRatingIconTypeÉnumération des types d'icônes de notation RatingIcons

Méthodes

MéthodeType renvoyéBrève description
create(title)FormCrée et renvoie un Form.
create(title, isPublished)FormCrée et renvoie un Form dans l'état de publication demandé.
createCheckboxGridValidation()CheckboxGridValidationBuilderRenvoie une instance de CheckboxGridValidationBuilder qui peut être utilisée pour définir la validation sur un CheckboxGridItem.
createCheckboxValidation()CheckboxValidationBuilderRenvoie une instance de CheckboxValidationBuilder qui peut être utilisée pour définir la validation sur un CheckboxItem.
createFeedback()QuizFeedbackBuilderRenvoie une instance de QuizFeedbackBuilder qui peut être utilisée pour définir des commentaires sur un Item pouvant être noté.
createGridValidation()GridValidationBuilderRenvoie une instance de GridValidationBuilder qui peut être utilisée pour définir la validation sur un GridItem.
createParagraphTextValidation()ParagraphTextValidationBuilderRenvoie une instance de ParagraphTextValidationBuilder qui peut être utilisée pour définir la validation sur un ParagraphTextItem.
createTextValidation()TextValidationBuilderRenvoie une instance de TextValidationBuilder qui peut être utilisée pour définir la validation sur un TextItem.
getActiveForm()FormRenvoie le formulaire auquel le script est lié au conteneur.
getUi()UiRenvoie une instance de l'environnement d'interface utilisateur de l'éditeur de formulaire qui permet au script d'ajouter des fonctionnalités telles que des menus, des boîtes de dialogue et des barres latérales.
openById(id)FormRenvoie le Form avec l'ID spécifié.
openByUrl(url)FormRenvoie le Form avec l'URL spécifiée.

Documentation détaillée

create(title)

Crée et renvoie un Form. Génère une exception si le titre donné est null ou vide. 

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

Paramètres

NomTypeDescription
titleStringNom du nouveau formulaire.

Renvois

Form : nouveau formulaire.

Génère

Error : si le titre donné est null ou vide

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

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

create(title, isPublished)

Crée et renvoie un Form dans l'état de publication demandé. Génère une exception si le titre donné est null ou vide. 

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

Paramètres

NomTypeDescription
titleStringNom du nouveau formulaire.
isPublishedBooleanIndique si le formulaire doit être publié.

Renvois

Form : nouveau formulaire.

Génère

Error : si le titre donné est null ou vide

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

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

createCheckboxGridValidation()

Renvoie une instance de CheckboxGridValidationBuilder qui peut être utilisée pour définir la validation sur un CheckboxGridItem.

Renvois

CheckboxGridValidationBuilder

createCheckboxValidation()

Renvoie une instance de CheckboxValidationBuilder qui peut être utilisée pour définir la validation sur un CheckboxItem.

Renvois

CheckboxValidationBuilder

createFeedback()

Renvoie une instance de QuizFeedbackBuilder qui peut être utilisée pour définir des commentaires sur un Item pouvant être noté.

Renvois

QuizFeedbackBuilder

createGridValidation()

Renvoie une instance de GridValidationBuilder qui peut être utilisée pour définir la validation sur un GridItem.

Renvois

GridValidationBuilder

createParagraphTextValidation()

Renvoie une instance de ParagraphTextValidationBuilder qui peut être utilisée pour définir la validation sur un ParagraphTextItem.

Renvois

ParagraphTextValidationBuilder

createTextValidation()

Renvoie une instance de TextValidationBuilder qui peut être utilisée pour définir la validation sur un TextItem.

Renvois

TextValidationBuilder

getActiveForm()

Renvoie le formulaire auquel le script est lié au conteneur. Pour interagir avec des formulaires auxquels le script n'est pas lié au conteneur, utilisez plutôt openById(id) ou openByUrl(url). 

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

Renvois

Form : formulaire auquel le script est lié, ou null si le script n'est pas lié à un formulaire

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

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

getUi()

Renvoie une instance de l'environnement d'interface utilisateur de l'éditeur de formulaire qui permet au script d'ajouter des fonctionnalités telles que des menus, des boîtes de dialogue et des barres latérales. Un script ne peut interagir avec l'interface utilisateur que pour la instance actuelle d'un éditeur de formulaire ouvert (et non la vue qu'un répondant voit), et uniquement si le script est lié au formulaire. Pour en savoir plus, consultez les guides sur les menus et les boîtes de dialogue et les barres latérales. 

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

Renvois

Ui : instance de l'environnement d'interface utilisateur de ce formulaire

openById(id)

Renvoie le Form avec l'ID spécifié. Génère une exception si l'ID n'est pas valide ou si l'utilisateur n'est pas autorisé à ouvrir le formulaire. 

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

Paramètres

NomTypeDescription
idStringID du formulaire à ouvrir

Renvois

Form : formulaire avec l'ID donné

Génère

Error : si l'ID donné n'est pas valide ou si l'utilisateur ne dispose pas des autorisations suffisantes

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

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

openByUrl(url)

Renvoie le Form avec l'URL spécifiée. Génère une exception si l'URL n'est pas valide ou si l'utilisateur n'est pas autorisé à ouvrir le formulaire. 

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

Paramètres

NomTypeDescription
urlStringURL du formulaire à ouvrir

Renvois

Form : formulaire avec l'URL donnée

Génère

Error : si l'URL donnée n'est pas valide ou si l'utilisateur ne dispose pas des autorisations suffisantes

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

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