Class FormApp

FormulaireApplication

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 des images.
DestinationTypeDestinationTypeÉnumération des types de destinations pouvant stocker les réponses aux formulaires.
FeedbackTypeFeedbackTypeÉnumération des types de formulaire Feedbacks.
ItemTypeItemTypeÉnumération des types de formulaire Items.
PageNavigationTypePageNavigationTypeÉnumération des comportements possibles pour la navigation entre les pages.

Méthodes

MéthodeType renvoyéBrève description
create(title)FormCrée et affiche un Form.
createCheckboxGridValidation()CheckboxGridValidationBuilderRenvoie une instance d'un CheckboxGridValidationBuilder qui peut être utilisé pour définir la validation sur un CheckboxGridItem.
createCheckboxValidation()CheckboxValidationBuilderRenvoie une instance d'un CheckboxValidationBuilder qui peut être utilisé 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 évaluable.
createGridValidation()GridValidationBuilderRenvoie une instance de GridValidationBuilder qui peut être utilisée pour définir la validation sur un GridItem.
createParagraphTextValidation()ParagraphTextValidationBuilderRenvoie une instance d'un ParagraphTextValidationBuilder qui peut être utilisé 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 formulaires 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 l'Form avec l'ID spécifié.
openByUrl(url)FormRenvoie l'Form avec l'URL spécifiée.

Documentation détaillée

create(title)

Crée et affiche 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

createCheckboxGridValidation()

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

Renvois

CheckboxGridValidationBuilder


createCheckboxValidation()

Renvoie une instance d'un CheckboxValidationBuilder qui peut être utilisé 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 évaluable.

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 d'un ParagraphTextValidationBuilder qui peut être utilisé 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 formulaires 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 qu'avec l'UI de l'instance actuelle d'un éditeur de formulaire ouvert (et non avec la vue que voit le répondant) 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 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 l'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 associé à 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 l'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
urlStringl'URL du formulaire à ouvrir ;

Renvois

Form : le formulaire avec l'URL donnée

Génère

Error : si l'URL indiquée est incorrecte ou si l'utilisateur ne dispose pas d'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