Class ListItem

Élément de liste

Élément de question permettant au répondant de sélectionner une option dans une liste déroulante. Vous pouvez accéder aux éléments ou en créer à partir d'un Form.

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?').setChoices([
  item.createChoice('Cats'), item.createChoice('Dogs')
]);

Méthodes

Méthode	Type renvoyé	Brève description
createChoice(value)	Choice	Crée un choix.
createChoice(value, isCorrect)	Choice	Crée un choix.
createChoice(value, navigationItem)	Choice	Crée un choix avec une option de navigation de page qui saute vers un élément de page-break donné.
createChoice(value, navigationType)	Choice	Crée un choix avec une option de navigation de page.
createResponse(response)	ItemResponse	Crée un ItemResponse pour cet élément de liste.
duplicate()	ListItem	Crée une copie de cet élément et l'ajoute à la fin du formulaire.
getChoices()	Choice[]	Récupère toutes les options d'un élément.
getFeedbackForCorrect()	QuizFeedback	Renvoie les commentaires qui s'affichent auprès des personnes interrogées lorsqu'elles répondent correctement à une question.
getFeedbackForIncorrect()	QuizFeedback	Renvoie les commentaires qui s'affichent auprès des personnes interrogées lorsqu'elles répondent de manière incorrecte à une question.
getHelpText()	String	Récupère le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).
getId()	Integer	Récupère l'identifiant unique de l'élément.
getIndex()	Integer	Récupère l'index de l'élément parmi tous les éléments du formulaire.
getPoints()	Integer	Renvoie la valeur en points d'un élément évaluable.
getTitle()	String	Récupère le titre de l'élément (parfois appelé "texte d'en-tête", dans le cas d'un SectionHeaderItem).
getType()	ItemType	Récupère le type de l'élément, représenté par un ItemType.
isRequired()	Boolean	Indique si la personne interrogée doit répondre à la question.
setChoiceValues(values)	ListItem	Définit les choix pour un élément à partir d'un tableau de chaînes.
setChoices(choices)	ListItem	Définit un tableau d'options pour un élément.
setFeedbackForCorrect(feedback)	ListItem	Définit les commentaires à afficher aux personnes interrogées lorsqu'elles répondent correctement à une question.
setFeedbackForIncorrect(feedback)	ListItem	Définit les commentaires à afficher aux personnes interrogées lorsqu'elles répondent de manière incorrecte à une question.
setHelpText(text)	ListItem	Définit le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).
setPoints(points)	ListItem	Définit le nombre de points d'un élément évaluable.
setRequired(enabled)	ListItem	Indique si la personne interrogée doit répondre à la question.
setTitle(title)	ListItem	Définit le titre de l'élément (parfois appelé "texte d'en-tête", dans le cas d'un SectionHeaderItem).

Documentation détaillée

createChoice(value)

Crée un choix.

Paramètres

Nom	Type	Description
value	String	la valeur du choix, qui s'affiche sous forme de libellé pour les personnes interrogées lorsqu'elles consultent le formulaire

Renvois

Choice : le nouveau choix

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

---

createChoice(value, isCorrect)

Crée un choix.

Paramètres

Nom	Type	Description
value	String	la valeur du choix, qui s'affiche sous forme de libellé pour les personnes interrogées lorsqu'elles consultent le formulaire
isCorrect	Boolean	si la réponse est correcte ;

Renvois

Choice : le nouveau choix

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

---

createChoice(value, navigationItem)

Crée un choix avec une option de navigation de page qui saute vers un élément de page-break donné. Cela équivaut à createChoice(value, navigationType) avec navigationType défini sur FormApp.PageNavigationType.GO_TO_PAGE. Les choix qui utilisent la navigation sur les pages ne peuvent pas être combinés dans le même élément avec des choix qui n'utilisent pas la navigation sur les pages.

La navigation sur les pages se produit une fois que le participant a terminé une page contenant l'option, et uniquement s'il a choisi cette option. Si le répondant a choisi plusieurs options avec des instructions de navigation sur la même page, seule la dernière option de navigation a un effet. La navigation entre les pages n'a pas non plus d'incidence sur la dernière page d'un formulaire.

Paramètres

Nom	Type	Description
value	String	la valeur du choix, qui s'affiche sous forme de libellé pour les personnes interrogées lorsqu'elles consultent le formulaire
navigationItem	PageBreakItem	l'élément vers lequel vous souhaitez naviguer

Renvois

Choice : le nouveau choix

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

---

createChoice(value, navigationType)

Crée un choix avec une option de navigation de page. Les choix qui utilisent la navigation sur les pages ne peuvent pas être combinés dans le même élément avec des choix qui n'utilisent pas la navigation sur les pages.

La navigation sur les pages se produit une fois que le participant a terminé une page contenant l'option, et uniquement s'il a choisi cette option. Si le répondant a choisi plusieurs options avec des instructions de navigation sur la même page, seule la dernière option de navigation a un effet. La navigation entre les pages n'a pas non plus d'incidence sur la dernière page d'un formulaire.

Paramètres

Nom	Type	Description
value	String	la valeur du choix, qui s'affiche sous forme de libellé pour les personnes interrogées lorsqu'elles consultent le formulaire
navigationType	PageNavigationType	le type de navigation du choix ;

Renvois

Choice : le nouveau choix

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

---

createResponse(response)

Crée un ItemResponse pour cet élément de liste. Génère une exception si l'argument response ne correspond pas à un choix valide pour cet élément.

Paramètres

Nom	Type	Description
response	String	une réponse valide pour cet élément de liste

Renvois

ItemResponse : réponse de l'élément

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

---

duplicate()

Crée une copie de cet élément et l'ajoute à la fin du formulaire.

Renvois

ListItem : double de cet élément ListItem, pour le chaînage

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

---

getChoices()

Récupère toutes les options d'un élément.

Renvois

Choice[] : tableau d'options

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

---

getFeedbackForCorrect()

Renvoie les commentaires qui s'affichent auprès des personnes interrogées lorsqu'elles répondent correctement à une question.

Renvois

QuizFeedback : commentaires, le cas échéant.

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

---

getFeedbackForIncorrect()

Renvoie les commentaires qui s'affichent auprès des personnes interrogées lorsqu'elles répondent de manière incorrecte à une question.

Renvois

QuizFeedback : commentaires, le cas échéant.

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

---

getHelpText()

Récupère le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).

Renvois

String : texte d'aide ou de description de l'élément

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

---

getId()

Récupère l'identifiant unique de l'élément.

Renvois

Integer : ID de l'article

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

---

getIndex()

Récupère l'index de l'élément parmi tous les éléments du formulaire.

Renvois

Integer : index de l'élément

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

---

getPoints()

Renvoie la valeur en points d'un élément évaluable.

Renvois

Integer : nombre de points qu'une question rapporte.

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

---

getTitle()

Récupère le titre de l'élément (parfois appelé "texte d'en-tête", dans le cas d'un SectionHeaderItem).

Renvois

String : titre ou texte d'en-tête de l'élément

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

---

getType()

Récupère le type de l'élément, représenté par un ItemType.

Renvois

ItemType : type de l'élément

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

---

isRequired()

Indique si la personne interrogée doit répondre à la question.

Renvois

Boolean : indique si la personne interrogée doit répondre à la question

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

---

setChoiceValues(values)

Définit les choix pour un élément à partir d'un tableau de chaînes. Génère une exception si le tableau donné est vide.

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoiceValues(['Dogs', 'Cats']);

Paramètres

Nom	Type	Description
values	String[]	le tableau des valeurs de choix, qui s'affichent sous forme de libellés pour les personnes interrogées lorsqu'elles consultent le formulaire

Renvois

ListItem : ListItem, pour le chaînage

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

---

setChoices(choices)

Définit un tableau d'options pour un élément. Génère une exception si le tableau donné est vide ou contient un élément null.

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoices([item.createChoice('Cats'), item.createChoice('Dogs')]);

Paramètres

Nom	Type	Description
choices	Choice[]	un tableau d'options

Renvois

ListItem : ListItem, pour le chaînage

Génère

Error : si le tableau donné est null, vide ou contient un élément null

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

---

setFeedbackForCorrect(feedback)

Définit les commentaires à afficher aux personnes interrogées lorsqu'elles répondent correctement à une question.

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
// Set "Dogs" as the correct answer to this question.
item.setChoices([
  item.createChoice('Dogs', true),
  item.createChoice('Cats', false),
]);
// Add feedback which will be shown for correct responses; ie "Dogs".
item.setFeedbackForCorrect(
    FormApp.createFeedback().setDisplayText('Dogs rule, cats drool.').build(),
);

Paramètres

Nom	Type	Description
feedback	QuizFeedback	les nouveaux commentaires. Une valeur nulle efface les commentaires.

Renvois

ListItem : ListItem, pour le chaînage

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

---

setFeedbackForIncorrect(feedback)

Définit les commentaires à afficher aux personnes interrogées lorsqu'elles répondent de manière incorrecte à une question.

Paramètres

Nom	Type	Description
feedback	QuizFeedback	les nouveaux commentaires

Renvois

ListItem : ListItem, pour le chaînage

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

---

setHelpText(text)

Définit le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).

Paramètres

Nom	Type	Description
text	String	le nouveau texte d'aide ;

Renvois

ListItem : ListItem, pour le chaînage

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

---

setPoints(points)

Définit le nombre de points d'un élément évaluable. La valeur par défaut pour les nouveaux éléments est 0.

Paramètres

Nom	Type	Description
points	Integer	le nombre de points qu'un élément de question vaut

Renvois

ListItem : ListItem, pour le chaînage

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

---

setRequired(enabled)

Indique si la personne interrogée doit répondre à la question.

Paramètres

Nom	Type	Description
enabled	Boolean	si la personne interrogée doit répondre à la question

Renvois

ListItem : élément actuel (pour l'association en chaîne)

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

---

setTitle(title)

Définit le titre de l'élément (parfois appelé "texte d'en-tête", dans le cas d'un SectionHeaderItem).

Paramètres

Nom	Type	Description
title	String	le nouveau titre ou le nouveau texte de l'en-tête ;

Renvois

ListItem : ListItem, pour le chaînage

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