Class Form

Form

Formulaire contenant les propriétés et éléments généraux. Les propriétés incluent le titre, les paramètres et l'emplacement de stockage des réponses. Les éléments incluent des questions telles que des cases à cocher ou des cases d'option, tandis que les éléments de mise en page font référence à des éléments tels que les sauts de page. Vous pouvez accéder aux formulaires et en créer depuis FormApp. 

// Open a form by ID and create a new spreadsheet.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var ss = SpreadsheetApp.create('Spreadsheet Name');

// Update form properties via chaining.
form.setTitle('Form Name')
    .setDescription('Description of form')
    .setConfirmationMessage('Thanks for responding!')
    .setAllowResponseEdits(true)
    .setAcceptingResponses(false);

// Update the form's response destination.
form.setDestination(FormApp.DestinationType.SPREADSHEET, ss.getId());

Méthodes

MéthodeType renvoyéBrève description
addCheckboxGridItem()CheckboxGridItemAjoute un nouvel élément de question, présenté sous la forme d'une grille de colonnes et de lignes, qui permet au répondant de sélectionner plusieurs choix par ligne à partir d'une séquence de cases à cocher.
addCheckboxItem()CheckboxItemAjoute une nouvelle question permettant à la personne interrogée de cocher une ou plusieurs cases, ainsi qu'un champ facultatif "Autre".
addDateItem()DateItemAjoute une nouvelle question qui permet au répondant d'indiquer une date.
addDateTimeItem()DateTimeItemAjoute une nouvelle question qui permet au répondant d'indiquer une date et une heure.
addDurationItem()DurationItemAjoute une nouvelle question qui permet à la personne interrogée d'indiquer une durée.
addEditor(emailAddress)FormAjoute l'utilisateur donné à la liste des éditeurs pour Form.
addEditor(user)FormAjoute l'utilisateur donné à la liste des éditeurs pour Form.
addEditors(emailAddresses)FormAjoute le tableau d'utilisateurs indiqué à la liste des éditeurs pour Form.
addGridItem()GridItemAjoute un nouvel élément de question, présenté sous la forme d'une grille de colonnes et de lignes, qui permet au répondant de sélectionner un choix par ligne à partir d'une séquence de cases d'option.
addImageItem()ImageItemAjoute un nouvel élément de mise en page qui affiche une image.
addListItem()ListItemAjoute une nouvelle question qui permet à la personne interrogée de sélectionner une réponse dans une liste déroulante.
addMultipleChoiceItem()MultipleChoiceItemAjoute une nouvelle question qui permet à la personne interrogée de sélectionner un choix dans une liste de cases d'option ou un champ facultatif "Autre".
addPageBreakItem()PageBreakItemAjoute un nouvel élément de mise en page qui marque le début d'une page.
addParagraphTextItem()ParagraphTextItemAjoute une nouvelle question qui permet à la personne interrogée de saisir un bloc de texte.
addScaleItem()ScaleItemAjoute une nouvelle question qui permet au répondant de choisir une option dans une séquence numérotée de cases d'option.
addSectionHeaderItem()SectionHeaderItemAjoute un nouvel élément de mise en page qui indique visuellement le début d'une section.
addTextItem()TextItemAjoute une nouvelle question, qui permet à la personne interrogée de saisir une seule ligne de texte.
addTimeItem()TimeItemAjoute une nouvelle question qui permet au répondant d'indiquer une heure de la journée.
addVideoItem()VideoItemAjoute un nouvel élément de mise en page qui affiche une vidéo.
canEditResponse()BooleanDétermine si le formulaire doit afficher un lien permettant de modifier une réponse après l'avoir envoyée.
collectsEmail()BooleanDétermine si le formulaire collecte les adresses e-mail des personnes interrogées.
createResponse()FormResponseCrée une réponse au formulaire.
deleteAllResponses()FormSupprime toutes les réponses envoyées du magasin de réponses du formulaire.
deleteItem(index)voidSupprime l'élément avec un indice donné parmi tous les éléments du formulaire.
deleteItem(item)voidSupprime l'élément donné.
deleteResponse(responseId)FormSupprime une seule réponse du magasin de réponses du formulaire.
getConfirmationMessage()StringRécupère le message de confirmation du formulaire.
getCustomClosedFormMessage()StringRécupère le message personnalisé qui s'affiche si le formulaire n'accepte pas de réponses, ou une chaîne vide si aucun message personnalisé n'est défini.
getDescription()StringRécupère la description du formulaire.
getDestinationId()StringRécupère l'ID de destination de la réponse du formulaire.
getDestinationType()DestinationTypeRécupère le type de destination de la réponse du formulaire.
getEditUrl()StringRécupère l'URL permettant d'accéder au mode Édition du formulaire.
getEditors()User[]Récupère la liste des éditeurs pour ce Form.
getId()StringRécupère l'ID du formulaire.
getItemById(id)ItemRécupère l'élément ayant un identifiant donné.
getItems()Item[]Récupère un tableau de tous les éléments du formulaire.
getItems(itemType)Item[]Récupère un tableau de tous les éléments d'un type donné.
getPublishedUrl()StringRécupère l'URL qui peut être utilisée pour répondre au formulaire.
getResponse(responseId)FormResponseRécupère une seule réponse de formulaire en fonction de son ID de réponse.
getResponses()FormResponse[]Récupère un tableau contenant toutes les réponses du formulaire.
getResponses(timestamp)FormResponse[]Récupère un tableau de toutes les réponses du formulaire après une date et une heure données.
getShuffleQuestions()BooleanDétermine si l'ordre des questions sur chaque page du formulaire est aléatoire.
getSummaryUrl()StringRécupère l'URL permettant d'afficher un résumé des réponses du formulaire.
getTitle()StringRécupère le titre du formulaire.
hasLimitOneResponsePerUser()BooleanDétermine si le formulaire n'autorise qu'une seule réponse par personne interrogée.
hasProgressBar()BooleanDétermine si le formulaire doit afficher une barre de progression.
hasRespondAgainLink()BooleanDétermine si le formulaire affiche un lien permettant d'envoyer une autre réponse une fois que la personne interrogée a rempli le formulaire.
isAcceptingResponses()BooleanDétermine si le formulaire accepte actuellement des réponses.
isPublishingSummary()BooleanDétermine si le formulaire doit afficher un lien permettant d'afficher un résumé des réponses une fois que la personne interrogée l'a rempli.
isQuiz()BooleanDétermine si le formulaire est un questionnaire.
moveItem(from, to)ItemDéplace un élément d'un indice donné entre tous les éléments du formulaire vers un autre indice donné.
moveItem(item, toIndex)ItemDéplace un élément donné vers un index donné parmi tous les éléments du formulaire.
removeDestination()FormDissocie le formulaire de sa destination de réponse actuelle.
removeEditor(emailAddress)FormSupprime l'utilisateur indiqué de la liste des éditeurs pour Form.
removeEditor(user)FormSupprime l'utilisateur indiqué de la liste des éditeurs pour Form.
requiresLogin()BooleanDétermine si le formulaire oblige les personnes interrogées à se connecter à un compte du même domaine ou à un sous-domaine pour pouvoir répondre.
setAcceptingResponses(enabled)FormDétermine si le formulaire accepte actuellement des réponses.
setAllowResponseEdits(enabled)FormDétermine si le formulaire affiche un lien permettant de modifier la réponse après l'avoir envoyée.
setCollectEmail(collect)FormDétermine si le formulaire collecte les adresses e-mail des personnes interrogées.
setConfirmationMessage(message)FormDéfinit le message de confirmation du formulaire.
setCustomClosedFormMessage(message)FormDéfinit le message à afficher si le formulaire n'accepte pas de réponses.
setDescription(description)FormDéfinit la description du formulaire.
setDestination(type, id)FormDéfinit la destination où les réponses au formulaire sont enregistrées.
setIsQuiz(enabled)FormDétermine si le formulaire est un questionnaire.
setLimitOneResponsePerUser(enabled)FormDétermine si le formulaire n'autorise qu'une seule réponse par personne interrogée.
setProgressBar(enabled)FormDétermine si le formulaire comporte une barre de progression.
setPublishingSummary(enabled)FormDétermine si le formulaire affiche un lien permettant d'afficher un résumé des réponses une fois qu'une personne interrogée l'a envoyé.
setRequireLogin(requireLogin)FormDétermine si les personnes interrogées doivent se connecter à un compte du même domaine ou à un sous-domaine pour pouvoir répondre.
setShowLinkToRespondAgain(enabled)FormDétermine si le formulaire affiche un lien permettant d'envoyer une autre réponse lorsqu'une personne interrogée a rempli le formulaire.
setShuffleQuestions(shuffle)FormDétermine si l'ordre des questions sur chaque page du formulaire est aléatoire.
setTitle(title)FormDéfinit le titre du formulaire.
shortenFormUrl(url)StringConvertit une URL longue d'un formulaire en URL courte.
submitGrades(responses)FormEnvoie les notes pour les réponses FormResponse données.

Documentation détaillée

addCheckboxGridItem()

Ajoute un nouvel élément de question, présenté sous la forme d'une grille de colonnes et de lignes, qui permet au répondant de sélectionner plusieurs choix par ligne à partir d'une séquence de cases à cocher. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds a checkbox grid item.
const item = form.addCheckboxGridItem();

// Sets the title 'Where did you celebrate New Year's?'
item.setTitle('Where did you celebrate New Year's?');

// Sets the grid's rows and columns.
item.setRows(['New York', 'San Francisco', 'London'])
  .setColumns(['2014', '2015', '2016', '2017']);

Renvois

CheckboxGridItem : élément nouvellement créé

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

addCheckboxItem()

Ajoute une nouvelle question permettant à la personne interrogée de cocher une ou plusieurs cases, ainsi qu'un champ facultatif "Autre". 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds a checkbox item.
const item = form.addCheckboxItem();

// Sets the title of the checkbox item to 'Do you prefer cats or dogs?'
item.setTitle('Do you prefer cats or dogs?');

// Sets the choices.
item.setChoiceValues(['Cats', 'Dogs']);

Renvois

CheckboxItem : élément nouvellement créé

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

addDateItem()

Ajoute une nouvelle question qui permet au répondant d'indiquer une date. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds a date item.
const item = form.addDateItem();

// Sets the title to 'When were you born?'
item.setTitle('When were you born?');

// Sets the description for the date item.
item.setHelpText('Some helper text.');

Renvois

DateItem : élément nouvellement créé

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

addDateTimeItem()

Ajoute une nouvelle question qui permet au répondant d'indiquer une date et une heure. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds a question with date and time inputs.
const item = form.addDateTimeItem();

// Sets the title to 'When were you born?'
item.setTitle('When were you born?');

// Sets the question as required.
item.setRequired(true);

Renvois

DateTimeItem : élément nouvellement créé

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

addDurationItem()

Ajoute une nouvelle question qui permet à la personne interrogée d'indiquer une durée. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds a question with a duration input.
const item = form.addDurationItem();

// Sets the title to 'How long can you hold your breath?'
item.setTitle('How long can you hold your breath?');

// Sets the question as required.
item.setRequired(true);

Renvois

DurationItem : élément nouvellement créé

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

addEditor(emailAddress)

Ajoute l'utilisateur donné à la liste des éditeurs pour Form. Si l'utilisateur figurait déjà dans la liste des visiteurs, cette méthode l'exclut de la liste.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à ajouter.

Renvois

Form : Form, pour le chaînage.

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

addEditor(user)

Ajoute l'utilisateur donné à la liste des éditeurs pour Form. Si l'utilisateur figurait déjà dans la liste des visiteurs, cette méthode l'exclut de la liste.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à ajouter.

Renvois

Form : Form, pour le chaînage.

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

addEditors(emailAddresses)

Ajoute le tableau d'utilisateurs indiqué à la liste des éditeurs pour Form. Si l'un des utilisateurs figurait déjà dans la liste des lecteurs, cette méthode l'exclut de la liste.

Paramètres

NomTypeDescription
emailAddressesString[]Tableau des adresses e-mail des utilisateurs à ajouter.

Renvois

Form : Form, pour le chaînage.

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

addGridItem()

Ajoute un nouvel élément de question, présenté sous la forme d'une grille de colonnes et de lignes, qui permet au répondant de sélectionner un choix par ligne à partir d'une séquence de cases d'option. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds a multiple choice grid.
const item = form.addGridItem();

// Sets the title to 'Rate your interests.'
item.setTitle('Rate your interests');

// Sets the grid's rows and columns.
item.setRows(['Cars', 'Computers', 'Celebrities'])
  .setColumns(['Boring', 'So-so', 'Interesting']);

Renvois

GridItem : élément nouvellement créé

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

addImageItem()

Ajoute un nouvel élément de mise en page qui affiche une image. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds an image item.
const item = form.addImageItem();

// Gets the Google icon to use as the image.
const img = UrlFetchApp.fetch('https://fonts.gstatic.com/s/i/productlogos/googleg/v6/web-24dp/logo_googleg_color_1x_web_24dp.png');

// Sets the image, title, and description for the item.
item.setTitle('Google icon').setHelpText('Google icon').setImage(img);

Renvois

ImageItem : élément nouvellement créé

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

addListItem()

Ajoute une nouvelle question qui permet à la personne interrogée de sélectionner une réponse dans une liste déroulante. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds a dropdown list to the form.
const item = form.addListItem();

// Sets the title to 'Do you prefer cats or dogs?'
item.setTitle('Do you prefer cats or dogs?');

// Sets the description to 'This is description text...'
item.setHelpText('This is description text...');

// Creates and adds choices to the dropdown list.
item.setChoices([
  item.createChoice('dog'),
  item.createChoice('cat')
]);

Renvois

ListItem : élément nouvellement créé

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

addMultipleChoiceItem()

Ajoute une nouvelle question qui permet à la personne interrogée de sélectionner un choix dans une liste de cases d'option ou un champ facultatif "Autre". 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds a multiple choice item to the form.
const item = form.addMultipleChoiceItem();

// Sets the title.
item.setTitle('What is your favorite ice cream flavor?');

// Creates some choice items.
const vanilla = item.createChoice('vanilla');
const chocolate = item.createChoice('chocolate');
const strawberry = item.createChoice('strawberry');

// Sets the choices.
item.setChoices([vanilla, chocolate, strawberry]);

Renvois

MultipleChoiceItem : élément nouvellement créé

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

addPageBreakItem()

Ajoute un nouvel élément de mise en page qui marque le début d'une page. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds page break items to create a second and third page for the form.
const pageTwo = form.addPageBreakItem();
const pageThree = form.addPageBreakItem();

// Sets the titles for the pages.
pageTwo.setTitle('Page two');
pageThree.setTitle('Page three');

// Upon completion of the first page, sets the form to navigate to the third page.
pageTwo.setGoToPage(pageThree);

// Upon completion of the second page, sets the form to navigate back to the first page.
pageThree.setGoToPage(FormApp.PageNavigationType.RESTART);

Renvois

PageBreakItem : élément nouvellement créé

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

addParagraphTextItem()

Ajoute une nouvelle question qui permet à la personne interrogée de saisir un bloc de texte. 

// Opens the form by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds the paragraph text item.
const item = form.addParagraphTextItem();

// Sets the title to 'What is your address?'
item.setTitle('What is your address?');

Renvois

ParagraphTextItem : élément nouvellement créé

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

addScaleItem()

Ajoute une nouvelle question qui permet au répondant de choisir une option dans une séquence numérotée de cases d'option. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds the scale item.
const item = form.addScaleItem();

// Sets the title of the scale item to 'Choose a number.'
item.setTitle('Choose a number');

// Sets the scale to 1-5.
item.setBounds(1, 5);

// Sets the label for the lower and upper bounds.
item.setLabels('Lowest', 'Highest');

Renvois

ScaleItem : élément nouvellement créé

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

addSectionHeaderItem()

Ajoute un nouvel élément de mise en page qui indique visuellement le début d'une section. 

 // Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds the section heading item.
const item = form.addSectionHeaderItem();

// Sets the title to 'Title of new section.'
item.setTitle('Title of new section');

// Sets the description.
item.setHelpText('Description of new section');

Renvois

SectionHeaderItem : élément nouvellement créé

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

addTextItem()

Ajoute une nouvelle question, qui permet à la personne interrogée de saisir une seule ligne de texte. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds a single-line text item.
const item = form.addTextItem();

// Sets the title to 'What is your name?'
item.setTitle('What is your name?');

Renvois

TextItem : élément nouvellement créé

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

addTimeItem()

Ajoute une nouvelle question qui permet au répondant d'indiquer une heure de la journée. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds a question with a time input.
const item = form.addTimeItem();

// Sets the title to 'What time do you usually wake up in the morning?'
item.setTitle('What time do you usually wake up in the morning?');

Renvois

TimeItem : élément nouvellement créé

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

addVideoItem()

Ajoute un nouvel élément de mise en page qui affiche une vidéo. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds a video item.
const item = form.addVideoItem();

// Sets the title, description, and video.
item.setTitle('YouTube video')
  .setHelpText('Send content automatically via Google Sheets and Apps Script')
  .setVideoUrl('https://youtu.be/xxgQr-jSu9o');

// Sets the alignment to the center.
item.setAlignment(FormApp.Alignment.CENTER);

Renvois

VideoItem : élément nouvellement créé

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

canEditResponse()

Détermine si le formulaire doit afficher un lien permettant de modifier une réponse après l'avoir envoyée.

Indépendamment de ce paramètre, la méthode FormResponse.getEditResponseUrl() permet à un auteur de script autorisé à modifier le formulaire de générer une URL pouvant être utilisée pour modifier une réponse. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Checks if the form displays a link to edit a response after submitting it.
// The default is false. To let people edit their responses, use
// form.setAllowResponseEdits(true).
const edit = form.canEditResponse();

// If the form doesn't let people edit responses, logs false to the console.
console.log(edit);

Renvois

Boolean : true si le formulaire affiche un lien "Modifier votre réponse", false dans le cas contraire.

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

collectsEmail()

Détermine si le formulaire collecte les adresses e-mail des personnes interrogées. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Sets the form to not collect respondents' email addresses.
form.setCollectEmail(false);

// Checks whether the form collects respondents' email addresses and logs it to the console.
const bool = form.collectsEmail();

console.log(bool);

Renvois

Boolean : true si le formulaire collecte des adresses e-mail, false dans le cas contraire.

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

createResponse()

Crée une réponse au formulaire. Pour répondre à une question, créez un ItemResponse à partir de l'élément, puis joignez-le à cette réponse de formulaire en appelant FormResponse.withItemResponse(response). Pour enregistrer la réponse assemblée, appelez FormResponse.submit().

Renvois

FormResponse : nouvelle réponse au 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

deleteAllResponses()

Supprime toutes les réponses envoyées du magasin de réponses du formulaire. Cette méthode ne supprime pas les copies des réponses stockées dans une destination de réponse externe (comme une feuille de calcul), mais efface l'affichage récapitulatif du formulaire.

Renvois

Form : Form, pour le chaînage.

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

deleteItem(index)

Supprime l'élément avec un indice donné parmi tous les éléments du formulaire. Génère une exception de script si aucun élément n'existe à l'index donné. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Gets all the items from the form.
const items = form.getItems();

// Finds the index of a paragraph text item and deletes it by the item's index.
const index = items.findIndex(item => item.getType() === FormApp.ItemType.PARAGRAPH_TEXT);
if (index !== -1) {
  form.deleteItem(index);
}

Paramètres

NomTypeDescription
indexIntegerIndice de l'élément parmi tous les éléments du formulaire.

Génère

Error : si aucun élément n'existe à l'index donné

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

deleteItem(item)

Supprime l'élément donné. Génère une exception de script si l'élément a déjà été supprimé. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Gets all of the items from the form.
const items = form.getItems();

// Finds a paragraph text item and deletes it.
const item = items.find(item => item.getType() === FormApp.ItemType.PARAGRAPH_TEXT);
if (item) {
  form.deleteItem(item);
}

Paramètres

NomTypeDescription
itemItemÉlément à supprimer.

Génère

Error : si l'élément n'existe pas dans le 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

deleteResponse(responseId)

Supprime une seule réponse du magasin de réponses du formulaire. Cette méthode ne supprime pas les copies des réponses stockées dans une destination de réponse externe (comme une feuille de calcul), mais elle supprime la réponse de la vue récapitulative du formulaire. L'ID de réponse peut être récupéré avec FormResponse.getId().

Paramètres

NomTypeDescription
responseIdStringID de la réponse du formulaire à supprimer.

Renvois

Form : Form, pour le chaînage.

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

getConfirmationMessage()

Récupère le message de confirmation du formulaire. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Sets the confirmation message to display after someone submits the form.
form.setConfirmationMessage('You successfully submitted the form.');

// Gets the confirmation message and logs it to the console.
const message = form.getConfirmationMessage();

console.log(message);

Renvois

String : message de confirmation du 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

getCustomClosedFormMessage()

Récupère le message personnalisé qui s'affiche si le formulaire n'accepte pas de réponses, ou une chaîne vide si aucun message personnalisé n'est défini. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Sets a custom closed form message to display to the user when the form
// no longer accepts responses.
form.setCustomClosedFormMessage('The form is no longer accepting responses.');

// Gets the custom message set for the form and logs it to the console.
const message = form.getCustomClosedFormMessage();

console.log(message);

Renvois

String : message personnalisé à afficher si le formulaire n'accepte pas de réponses, ou chaîne vide si aucun message personnalisé n'est défini.

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

getDescription()

Récupère la description du formulaire. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Sets the form description.
form.setDescription('This is the form description.');

// Gets the form description and logs it to the console.
const description = form.getDescription();

console.log(description);

Renvois

String : description du 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

getDestinationId()

Récupère l'ID de destination de la réponse du formulaire. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Creates a spreadsheet to use as the response destination.
const ss = SpreadsheetApp.create('Test_Spreadsheet');

// Updates the form's response destination.
form.setDestination(FormApp.DestinationType.SPREADSHEET, ss.getId());

// Gets the ID of the form's response destination and logs it to the console.
const destinationId = form.getDestinationId();

console.log(destinationId);

Renvois

String : ID de la destination de la réponse du 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

getDestinationType()

Récupère le type de destination de la réponse du formulaire. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc1234556/edit');

// Gets the type of the form's response destination and logs it to the console.
const destinationType = form.getDestinationType().name();

console.log(destinationType);

Renvois

DestinationType : type de destination de la réponse du 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

getEditUrl()

Récupère l'URL permettant d'accéder au mode Édition du formulaire. 

// Opens the form by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Gets the URL that accesses the form's edit mode and logs it to the console.
const url = form.getEditUrl();

console.log(url);

Renvois

String : URL pour modifier le 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

getEditors()

Récupère la liste des éditeurs pour ce Form.

Renvois

User[] : tableau des utilisateurs disposant de droits de modification.

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

getId()

Récupère l'ID du formulaire. 

// Opens the form by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Gets the ID of the form and logs it to the console.
const id = form.getId();

console.log(id);

Renvois

String : ID du 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

getItemById(id)

Récupère l'élément ayant un identifiant donné. Renvoie null si l'ID ne correspond pas à un élément du formulaire. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Gets the ID of the first item on the form.
const itemId = form.getItems()[0].getId();

// Gets the item from the ID.
const item = form.getItemById(itemId);

// Gets the name of the item type and logs it to the console.
const type = item.getType().name();

console.log(type);

Paramètres

NomTypeDescription
idIntegerID de l'élément.

Renvois

Item : élément avec l'ID donné ou null si l'élément n'existe pas dans le 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

getItems()

Récupère un tableau de tous les éléments du formulaire. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Gets the list of items in the form.
const items = form.getItems();

// Gets the type for each item and logs them to the console.
const types = items.map((item) => item.getType().name());

console.log(types);

Renvois

Item[] : tableau de tous les éléments du 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

getItems(itemType)

Récupère un tableau de tous les éléments d'un type donné. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Gets a list of all checkbox items on the form.
const items = form.getItems(FormApp.ItemType.CHECKBOX);

// Gets the title of each checkbox item and logs them to the console.
const checkboxItemsTitle = items.map((item) => item.asCheckboxItem().getTitle());
console.log(checkboxItemsTitle);

Paramètres

NomTypeDescription
itemTypeItemTypeType d'éléments à récupérer.

Renvois

Item[] : tableau de tous les éléments de ce type.

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

getPublishedUrl()

Récupère l'URL qui peut être utilisée pour répondre au formulaire. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Gets the URL to respond to the form and logs it to the console.
const url = form.getPublishedUrl();
console.log(url);

Renvois

String : URL de réponse au 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

getResponse(responseId)

Récupère une seule réponse de formulaire en fonction de son ID de réponse. Les ID de réponse peuvent être récupérés à partir de FormResponse.getId().

Paramètres

NomTypeDescription
responseIdStringID de la réponse du formulaire.

Renvois

FormResponse : réponse du formulaire.

Génère

Error : si la réponse n'existe pas

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

getResponses()

Récupère un tableau contenant toutes les réponses du formulaire.

Renvois

FormResponse[] : tableau de toutes les réponses du 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

getResponses(timestamp)

Récupère un tableau de toutes les réponses du formulaire après une date et une heure données.

Paramètres

NomTypeDescription
timestampDateDate et heure les plus anciennes auxquelles les réponses au formulaire doivent être renvoyées.

Renvois

FormResponse[] : liste des réponses au 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

getShuffleQuestions()

Détermine si l'ordre des questions sur chaque page du formulaire est aléatoire.

Renvois

Boolean : true si l'ordre des questions sur chaque page du formulaire est aléatoire ; false dans le cas contraire.

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

getSummaryUrl()

Récupère l'URL permettant d'afficher un résumé des réponses du formulaire. À moins que setPublishingSummary(enabled) ne soit défini sur true, seuls les utilisateurs autorisés à modifier le formulaire peuvent accéder à l'URL. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// Opens the form by its URL.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Gets the URL to view a summary of the form's responses and logs it to the console.
const url = form.getSummaryUrl();
console.log(url);

Renvois

String : URL permettant d'afficher un résumé des réponses.

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

getTitle()

Récupère le titre du formulaire. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Sets the title of the form to 'For_Testing.'
form.setTitle('For_Testing');

// Gets the title of the form and logs it to the console.
const title = form.getTitle();
console.log(title);

Renvois

String : titre du 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

hasLimitOneResponsePerUser()

Détermine si le formulaire n'autorise qu'une seule réponse par personne interrogée. Si cette valeur est true, le script ne peut pas envoyer de réponses au formulaire.

Renvois

Boolean : true si le formulaire n'autorise qu'une seule réponse par personne interrogée, false dans le cas contraire.

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

hasProgressBar()

Détermine si le formulaire doit afficher une barre de progression. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// Opens the form by its URL.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Displays the progress bar on the form.
form.setProgressBar(true);

// Checks if the form displays a progress bar and logs it to the console.
console.log(form.hasProgressBar());

Renvois

Boolean : true si le formulaire affiche une barre de progression, false dans le cas contraire.

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

Détermine si le formulaire affiche un lien permettant d'envoyer une autre réponse une fois que la personne interrogée a rempli le formulaire. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Sets the form to display a link to submit another
// response after someone submits the form.
form.setShowLinkToRespondAgain(true);

// Checks if the form displays a 'Submit another response' link and logs it to the console.
console.log(form.hasRespondAgainLink());

Renvois

Boolean : true si le formulaire affiche un lien "Envoyer une autre réponse" ; false dans le cas contraire.

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

isAcceptingResponses()

Détermine si le formulaire accepte actuellement des réponses. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Sets the form to accept responses.
form.setAcceptingResponses(true);

// Checks if the form is accepting responses or not and logs it to the console.
const accepting = form.isAcceptingResponses();
console.log(accepting);

Renvois

Boolean : true si le formulaire accepte des réponses, false dans le cas contraire.

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

isPublishingSummary()

Détermine si le formulaire doit afficher un lien permettant d'afficher un résumé des réponses une fois que la personne interrogée l'a rempli. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Sets the form to display a link to a summary of
// the responses after someone submits the form.
form.setPublishingSummary(true);

// Checks if the form displays a "See previous responses" link and logs it to the console.
const publishingLink = form.isPublishingSummary();
console.log(publishingLink);

Renvois

Boolean : true si le formulaire affiche un lien "Voir les réponses précédentes", false dans le cas contraire.

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

isQuiz()

Détermine si le formulaire est un questionnaire. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Sets the form as a quiz.
form.setIsQuiz(true);

// Checks if the form is a quiz or not and logs it to the console.
console.log(form.isQuiz());

Renvois

Boolean : true si le formulaire accepte des réponses, false dans le cas contraire.

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

moveItem(from, to)

Déplace un élément d'un indice donné entre tous les éléments du formulaire vers un autre indice donné. Génère une exception de script si l'index to est hors limites. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Moves the first item to be the last item.
form.moveItem(0, form.getItems().length - 1);

Paramètres

NomTypeDescription
fromIntegerIndex actuel de l'élément par rapport à tous les éléments du formulaire.
toIntegerNouvel index de l'élément parmi tous les éléments du formulaire.

Renvois

Item : élément déplacé.

Génère

Error : si l'un des index est hors limites.

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

moveItem(item, toIndex)

Déplace un élément donné vers un index donné parmi tous les éléments du formulaire. Génère une exception de script si l'index donné est hors limites. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Gets the first item.
const item = form.getItems()[0];

// Moves the item to be the last item.
form.moveItem(item, form.getItems().length - 1);

Paramètres

NomTypeDescription
itemItemÉlément à déplacer.
toIndexIntegerNouvel index de l'élément parmi tous les éléments du formulaire.

Renvois

Item : élément déplacé.

Génère

Error : si l'index est hors limites.

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

removeDestination()

Dissocie le formulaire de sa destination de réponse actuelle. L'ancienne destination dissociée conserve toujours une copie de toutes les réponses précédentes. Tous les formulaires, y compris ceux dont la destination n'est pas définie explicitement, enregistrez une copie des réponses dans le magasin de réponses du formulaire. Si le formulaire n'a pas de destination de réponse, cette méthode n'a aucun effet. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Opens a spreadsheet to use for the response destination.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Updates the form's response destination to the spreadsheet.
form.setDestination(FormApp.DestinationType.SPREADSHEET, ss.getId());

// Unlinks the form from the spreadsheet.
form.removeDestination();

Renvois

Form : Form, pour le chaînage.

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

removeEditor(emailAddress)

Supprime l'utilisateur indiqué de la liste des éditeurs pour Form. Cette méthode n'empêche pas les utilisateurs d'accéder au Form s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général (par exemple, si Form est partagé avec l'ensemble du domaine de l'utilisateur ou si Form se trouve dans un Drive partagé auquel l'utilisateur peut accéder).

Pour les fichiers Drive, cela supprime également l'utilisateur de la liste des lecteurs.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à supprimer.

Renvois

Form : Form, pour le chaînage.

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

removeEditor(user)

Supprime l'utilisateur indiqué de la liste des éditeurs pour Form. Cette méthode n'empêche pas les utilisateurs d'accéder au Form s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général (par exemple, si Form est partagé avec l'ensemble du domaine de l'utilisateur ou si Form se trouve dans un Drive partagé auquel l'utilisateur peut accéder).

Pour les fichiers Drive, cela supprime également l'utilisateur de la liste des lecteurs.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à supprimer.

Renvois

Form : Form, pour le chaînage.

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

requiresLogin()

Détermine si le formulaire oblige les personnes interrogées à se connecter à un compte du même domaine ou à un sous-domaine pour pouvoir répondre. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Checks if the form requires respondents to log in to a Google Workspace account
// before responding and logs it to the console.
const login = form.requiresLogin();
console.log(login);

Renvois

Boolean : true si le formulaire nécessite que les utilisateurs se connectent, false dans le cas contraire.

setAcceptingResponses(enabled)

Détermine si le formulaire accepte actuellement des réponses. La valeur par défaut pour les nouveaux formulaires est true. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Sets the form to accept responses.
form.setAcceptingResponses(true);

// Checks whether the form is accepting responses or not and logs it to the console.
console.log(form.isAcceptingResponses());

Paramètres

NomTypeDescription
enabledBooleantrue si le formulaire doit accepter des réponses, false dans le cas contraire.

Renvois

Form : Form, pour le chaînage.

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

setAllowResponseEdits(enabled)

Détermine si le formulaire affiche un lien permettant de modifier la réponse après l'avoir envoyée. La valeur par défaut pour les nouveaux formulaires est false.

Indépendamment de ce paramètre, la méthode FormResponse.getEditResponseUrl() permet à un auteur de script disposant de droits de modification du formulaire de générer une URL pouvant être utilisée pour modifier une réponse. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Shows "Edit your response" link after someone submits the form.
form.setAllowResponseEdits(true);

// Checks whether the option to edit the form after a user submits it is set to true or not
// and logs it to the console.
console.log(form.canEditResponse());

Paramètres

NomTypeDescription
enabledBooleantrue si le formulaire doit afficher un lien "Modifier votre réponse" ; false dans le cas contraire.

Renvois

Form : Form, pour le chaînage.

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

setCollectEmail(collect)

Détermine si le formulaire collecte les adresses e-mail des personnes interrogées. La valeur par défaut pour les nouveaux formulaires est false. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Sets the form to collect respondents' email addresses.
form.setCollectEmail(true);

// Checks whether the value is set to true or false and logs it to the console.
const collect = form.collectsEmail();
console.log(collect);

Paramètres

NomTypeDescription
collectBooleantrue si le formulaire doit collecter des adresses e-mail, false dans le cas contraire.

Renvois

Form : Form, pour le chaînage.

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

setConfirmationMessage(message)

Définit le message de confirmation du formulaire. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Sets a custom confirmation message to display after someone submits the form.
form.setConfirmationMessage('Your form has been successfully submitted.');

// Gets the confirmation message set for the form and logs it to the console.
const message = form.getConfirmationMessage();
console.log(message);

Paramètres

NomTypeDescription
messageStringNouveau message de confirmation du formulaire.

Renvois

Form : Form, pour le chaînage.

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

setCustomClosedFormMessage(message)

Définit le message à afficher si le formulaire n'accepte pas de réponses. Si aucun message n'est défini, le formulaire utilise un message par défaut. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Sets the form to not accept responses.
form.setAcceptingResponses(false);

// Sets a custom closed form message to display to the user.
form.setCustomClosedFormMessage('The form is no longer accepting responses.');

// Gets the custom message set for the form and logs it to the console.
const message = form.getCustomClosedFormMessage();
console.log(message);

Paramètres

NomTypeDescription
messageStringMessage à afficher si le formulaire n'accepte pas de réponses.

Renvois

Form : Form, pour le chaînage.

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

setDescription(description)

Définit la description du formulaire.

Paramètres

NomTypeDescription
descriptionStringNouvelle description du formulaire.

Renvois

Form : Form, pour le chaînage.

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

setDestination(type, id)

Définit la destination où les réponses au formulaire sont enregistrées. Tous les formulaires, y compris ceux dont la destination n'est pas définie explicitement, enregistrent une copie des réponses dans le magasin de réponses du formulaire.

Paramètres

NomTypeDescription
typeDestinationTypeType de destination de la réponse du formulaire.
idStringID de la destination de la réponse du formulaire.

Renvois

Form : Form, pour le chaînage.

Génère

Error : si l'ID de destination donné n'est pas valide

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

setIsQuiz(enabled)

Détermine si le formulaire est un questionnaire. La valeur par défaut pour les nouveaux formulaires est false.

Les questions notées ne sont autorisées que dans les questionnaires. Par conséquent, si vous définissez cette option sur false, toutes les options de notation seront supprimées de toutes les questions.

Les paramètres des questionnaires ne sont disponibles que dans la nouvelle interface utilisateur de Forms. Lorsque vous définissez un formulaire comme questionnaire, celui-ci est activé dans la nouvelle interface utilisateur. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Makes the form a quiz.
form.setIsQuiz(true);

// Checks whether the form is a quiz or not and logs it to the console.
console.log(form.isQuiz());

Paramètres

NomTypeDescription
enabledBooleantrue si les fonctionnalités de questionnaire doivent être activées pour le formulaire ; false dans le cas contraire.

Renvois

Form : Form, pour le chaînage.

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

setLimitOneResponsePerUser(enabled)

Détermine si le formulaire n'autorise qu'une seule réponse par personne interrogée. La valeur par défaut pour les nouveaux formulaires est false. Si la valeur est définie sur true, le script ne peut pas du tout envoyer de réponses au formulaire.

Paramètres

NomTypeDescription
enabledBooleantrue si le formulaire ne doit permettre qu'une seule réponse par personne interrogée ; false dans le cas contraire.

Renvois

Form : Form, pour le chaînage.

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

setProgressBar(enabled)

Détermine si le formulaire comporte une barre de progression. La valeur par défaut pour les nouveaux formulaires est false. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Displays the progress bar on the form.
form.setProgressBar(true);

// Checks whether the form has a progress bar and logs it to the console.
console.log(form.hasProgressBar());

Paramètres

NomTypeDescription
enabledBooleantrue si le formulaire affiche une barre de progression ; false dans le cas contraire.

Renvois

Form : Form, pour le chaînage.

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

setPublishingSummary(enabled)

Détermine si le formulaire affiche un lien permettant d'afficher un résumé des réponses une fois qu'une personne interrogée l'a envoyé. La valeur par défaut pour les nouveaux formulaires est false.

Paramètres

NomTypeDescription
enabledBooleantrue si le formulaire doit afficher un lien "Voir les réponses précédentes" ; false dans le cas contraire.

Renvois

Form : Form, pour le chaînage.

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

setRequireLogin(requireLogin)

Détermine si les personnes interrogées doivent se connecter à un compte du même domaine ou à un sous-domaine pour pouvoir répondre. La valeur par défaut des nouveaux formulaires est false, sauf si un administrateur de domaine la modifie.

Cette fonctionnalité n'est disponible que pour les formulaires créés par les utilisateurs de Google Workspace. Il n'est pas possible de demander aux utilisateurs d'autres types de comptes Google de se connecter. 

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Sets the form so that users must log in to their Google Workspace account.
form.setRequireLogin(true);

// Checks whether the form requires login or not and logs it to the console.
console.log(form.requiresLogin());

Paramètres

NomTypeDescription
requireLoginBooleantrue si le formulaire nécessite que les utilisateurs se connectent, false dans le cas contraire.

Renvois

Form : forme actuelle (pour le chaînage).

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

setShowLinkToRespondAgain(enabled)

Détermine si le formulaire affiche un lien permettant d'envoyer une autre réponse lorsqu'une personne interrogée a rempli le formulaire. La valeur par défaut pour les nouveaux formulaires est true.

Paramètres

NomTypeDescription
enabledBooleantrue si le formulaire doit afficher un lien "Envoyer une autre réponse" ; false dans le cas contraire.

Renvois

Form : Form, pour le chaînage.

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

setShuffleQuestions(shuffle)

Détermine si l'ordre des questions sur chaque page du formulaire est aléatoire.

Paramètres

NomTypeDescription
shuffleBooleantrue si l'ordre des questions sur chaque page du formulaire doit être aléatoire ; false dans le cas contraire.

Renvois

Form : Form, pour le chaînage.

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

setTitle(title)

Définit le titre du formulaire.

Paramètres

NomTypeDescription
titleStringNouveau titre du formulaire.

Renvois

Form : Form, pour le chaînage.

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

shortenFormUrl(url)

Convertit une URL longue d'un formulaire en URL courte. Génère une exception si l'URL longue n'appartient pas à Google Forms.

Paramètres

NomTypeDescription
urlStringURL à raccourcir.

Renvois

String : URL au format http://goo.gl/forms/1234.

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

submitGrades(responses)

Envoie les notes pour les réponses FormResponse données.

Si votre code inclut un déclencheur onFormSubmit, l'appel de submitGrades() déclenche la condition onFormSubmit et provoque une boucle infinie. Pour éviter la boucle infinie, ajoutez un code qui vérifie si les notes existent déjà avant d'appeler submitGrades().

Paramètres

NomTypeDescription
responsesFormResponse[]Tableau de toutes les réponses du formulaire.

Renvois

Form : Form, pour le chaînage.

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