Class FormApp

FormApp

Autorise un script à ouvrir un Form existant ou à en créer un.

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

// Create and open a form.
var 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 des réponses de formulaire.
FeedbackTypeFeedbackTypeÉnumération au format Feedbacks.
ItemTypeItemTypeÉnumération au format Items.
PageNavigationTypePageNavigationTypeÉnumération des comportements possibles pour la navigation sur les pages.

Méthodes

MéthodeType renvoyéBrève description
create(title)FormCrée et renvoie un Form.
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 pouvant ê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 pouvant ê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 dans lequel 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 la Form avec l'ID spécifié.
openByUrl(url)FormRenvoie la 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.
var form = FormApp.create('Form Name');

Paramètres

NomTypeDescription
titleStringle nom 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 associée à 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 pouvant ê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 pouvant ê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 dans lequel le script est lié au conteneur. Pour interagir avec les 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.
var 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 associée à 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 l'instance actuelle d'un éditeur de formulaire ouvert (et non avec la vue que voit la personne interrogée) et uniquement s'il 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 la Form avec l'ID spécifié. Elle 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.
var 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 associée à un ou plusieurs des champs d'application suivants:

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

openByUrl(url)

Renvoie la Form avec l'URL spécifiée. Elle 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.
var form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit'
    );

Paramètres

NomTypeDescription
urlStringl'URL 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 associée à un ou plusieurs des champs d'application suivants:

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