Cette page a été traduite par l'API Cloud Translation.

Class FormApp

Autorise un script à ouvrir un fichier 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é	Type	Description
`Alignment`	`Alignment`	Énumération des types d'alignement d'image.
`DestinationType`	`DestinationType`	Énumération des types de destinations pouvant stocker les réponses au formulaire.
`FeedbackType`	`FeedbackType`	Énumération des types du formulaire `Feedbacks`.
`ItemType`	`ItemType`	Énumération des types du formulaire `Items`.
`PageNavigationType`	`PageNavigationType`	Énumération des comportements possibles pour la navigation dans les pages.

Méthodes

Méthode	Type renvoyé	Brève description
`create(title)`	`Form`	Crée et affiche un objet `Form`.
`createCheckboxGridValidation()`	`CheckboxGridValidationBuilder`	Renvoie une instance de CheckboxGridValidationBuilder qui peut être utilisée pour définir la validation sur un `CheckboxGridItem`
`createCheckboxValidation()`	`CheckboxValidationBuilder`	Renvoie une instance de CheckboxValidationBuilder qui peut être utilisée pour définir la validation d'un `CheckboxItem`
`createFeedback()`	`QuizFeedbackBuilder`	Renvoie une instance de QuizFeedbackBuilder qui peut être utilisée pour définir des commentaires sur un élément à noter `Item`
`createGridValidation()`	`GridValidationBuilder`	Renvoie une instance de GridValidationBuilder qui peut être utilisée pour définir la validation sur un `GridItem`.
`createParagraphTextValidation()`	`ParagraphTextValidationBuilder`	Renvoie une instance de ParagraphTextValidationBuilder qui peut être utilisée pour définir la validation sur un `ParagraphTextItem`.
`createTextValidation()`	`TextValidationBuilder`	Renvoie une instance de TextValidationBuilder qui peut être utilisée pour définir la validation sur un `TextItem`.
`getActiveForm()`	`Form`	Renvoie le formulaire dans lequel le script est lié au conteneur.
`getUi()`	`Ui`	Renvoie une instance de l'environnement d'interface utilisateur de l'éditeur de formulaire qui permet au script ajouter des fonctionnalités telles que des menus, des boîtes de dialogue et des barres latérales.
`openById(id)`	`Form`	Renvoie le `Form` avec l'ID spécifié.
`openByUrl(url)`	`Form`	Renvoie l'élément `Form` avec l'URL spécifiée.

Documentation détaillée

`create(title)`

Crée et affiche un nouveau Form. Une exception est générée si le titre donné est null. ou vide.

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

Paramètres

Nom	Type	Description
`title`	`String`	le 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 correspondant à 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 d'un CheckboxItem

Renvois

CheckboxValidationBuilder

`createFeedback()`

Renvoie une instance de QuizFeedbackBuilder qui peut être utilisée pour définir des commentaires sur un élément à noter Item

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 dans lequel le script est lié au conteneur. Pour interagir avec des formulaires auxquels script n'est pas lié à un conteneur. Utilisez openById(id) ou openByUrl(url) à la place.

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

Renvois

Form : forme 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 correspondant à 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 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 visible par la personne interrogée), et uniquement si la script est lié au formulaire. Pour plus plus d'informations, consultez les guides sur les menus, ainsi que sur 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é. La fonction renvoie une exception si l'ID est incorrect ou si le l'utilisateur n'est pas autorisé à ouvrir le formulaire.

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

Paramètres

Nom	Type	Description
`id`	`String`	ID 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 n'a pas assez de données autorisations

Autorisation

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

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

`openByUrl(url)`

Renvoie l'élément Form avec l'URL spécifiée. La fonction renvoie une exception si l'URL est incorrecte ou l'utilisateur n'a pas l'autorisation d'ouvrir le formulaire.

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

Paramètres

Nom	Type	Description
`url`	`String`	l'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 n'a pas suffisamment de données autorisations

Autorisation

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

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