Class FormApp

Application de formulaire

Autorise un script à ouvrir un objet 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 aux formulaires.
FeedbackTypeFeedbackTypeÉnumération des types de Feedbacks.
ItemTypeItemTypeÉnumération des types de 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 objet Form.
createCheckboxGridValidation()CheckboxGridValidationBuilderRenvoie une instance d'un CheckboxGridValidationBuilder qui peut être utilisé pour définir la validation sur un objet CheckboxGridItem.
createCheckboxValidation()CheckboxValidationBuilderRenvoie une instance d'un CheckboxValidationBuilder qui peut être utilisé pour définir la validation sur un objet CheckboxItem.
createFeedback()QuizFeedbackBuilderRenvoie une instance d'un outil QuizFeedbackBuilder qui peut être utilisé pour définir des commentaires sur un objet Item notable.
createGridValidation()GridValidationBuilderRenvoie une instance de GridValidationBuilder qui peut être utilisée pour définir la validation sur un GridItem.
createParagraphTextValidation()ParagraphTextValidationBuilderAffiche 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é pour définir la validation sur un TextItem.
getActiveForm()FormRenvoie le formulaire dans lequel le script est lié à un 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 objet Form. Lève 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 ;

Aller-retour

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 objet CheckboxGridItem.

Aller-retour

CheckboxGridValidationBuilder


createCheckboxValidation()

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

Aller-retour

CheckboxValidationBuilder


createFeedback()

Renvoie une instance d'un outil QuizFeedbackBuilder qui peut être utilisé pour définir des commentaires sur un objet Item notable.

Aller-retour

QuizFeedbackBuilder


createGridValidation()

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

Aller-retour

GridValidationBuilder


createParagraphTextValidation()

Affiche une instance d'un ParagraphTextValidationBuilder qui peut être utilisé pour définir la validation sur un ParagraphTextItem.

Aller-retour

ParagraphTextValidationBuilder


createTextValidation()

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

Aller-retour

TextValidationBuilder


getActiveForm()

Renvoie le formulaire dans lequel le script est lié à un conteneur. Pour interagir avec les formulaires auxquels le script n'est pas lié à un conteneur, utilisez plutôt openById(id) ou openByUrl(url).

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

Aller-retour

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 de l'instance actuelle d'un éditeur de formulaire ouvert (pas la vue vue par la personne interrogée) et uniquement s'il est lié au formulaire. Pour en savoir plus, consultez les guides des menus, ainsi que 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();
}

Aller-retour

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


openById(id)

Renvoie le Form avec l'ID spécifié. Lève 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

Aller-retour

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. Lève 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
urlStringURL du formulaire à ouvrir

Aller-retour

Form : formulaire avec l'URL donnée

Génère

Error : si l'URL fournie n'est pas valide ou si l'utilisateur ne dispose pas des autorisations nécessaires

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