Class ListItem

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.
ListItem

Élément de question qui permet aux personnes interrogées de sélectionner une option dans une liste déroulante. Vous pouvez accéder aux éléments ou les créer depuis un Form.

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

Méthodes

MéthodeType renvoyéBrève description
createChoice(value)ChoiceCrée un choix.
createChoice(value, isCorrect)ChoiceCrée un choix.
createChoice(value, navigationItem)ChoiceCrée un choix avec une option de navigation vers les pages qui permet d'accéder à un élément de saut de page donné.
createChoice(value, navigationType)ChoiceCrée un choix avec une option de navigation sur les pages.
createResponse(response)ItemResponseCrée un ItemResponse pour cet élément de liste.
duplicate()ListItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getChoices()Choice[]Récupère tous les choix possibles pour un élément.
getFeedbackForCorrect()QuizFeedbackAffiche les commentaires fournis aux personnes interrogées lorsqu'elles répondent correctement à une question.
getFeedbackForIncorrect()QuizFeedbackAffiche les commentaires fournis aux personnes interrogées lorsqu'elles répondent mal à une question.
getHelpText()StringRé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()IntegerRécupère l'identifiant unique de l'article.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getPoints()IntegerAffiche le barème de notation d'un élément.
getTitle()StringRécupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'un élément SectionHeaderItem).
getType()ItemTypeRécupère le type de l'élément, représenté par ItemType.
isRequired()BooleanDétermine si la personne interrogée doit répondre à la question.
setChoiceValues(values)ListItemDéfinit les choix d'un élément à partir d'un tableau de chaînes.
setChoices(choices)ListItemDéfinit un tableau de choix pour un élément.
setFeedbackForCorrect(feedback)ListItemDéfinit les commentaires à afficher aux personnes interrogées lorsqu'elles répondent correctement à une question.
setFeedbackForIncorrect(feedback)ListItemDéfinit les commentaires à afficher aux personnes interrogées lorsqu'elles répondent mal à une question.
setHelpText(text)ListItemDé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)ListItemDéfinit le nombre de points qu'un élément notable vaut.
setRequired(enabled)ListItemCe paramètre détermine si la personne interrogée doit répondre à la question.
setTitle(title)ListItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'un élément SectionHeaderItem).

Documentation détaillée

createChoice(value)

Crée un choix.

Paramètres

NomTypeDescription
valueStringValeur du choix que les personnes interrogées voient sous forme de libellé lorsqu'elles consultent le formulaire

Aller-retour

Choice : 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

NomTypeDescription
valueStringValeur du choix que les personnes interrogées voient sous forme de libellé lorsqu'elles consultent le formulaire
isCorrectBooleansi la réponse est la bonne réponse

Aller-retour

Choice : 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 vers les pages qui permet d'accéder à un élément de saut de page 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 s'effectue une fois que la personne interrogée a terminé de consulter une page qui contient l'option et uniquement si elle a choisi cette option. Si la personne interrogée a choisi plusieurs options avec des instructions de navigation sur la même page, seule la dernière option de navigation a un effet. De plus, la navigation sur les pages n'a aucune incidence sur la dernière page d'un formulaire.

Paramètres

NomTypeDescription
valueStringValeur du choix que les personnes interrogées voient sous forme de libellé lorsqu'elles consultent le formulaire
navigationItemPageBreakIteml'élément auquel accéder

Aller-retour

Choice : 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 sur les pages. Les options qui utilisent la navigation sur les pages ne peuvent pas être combinées dans le même élément avec des options qui n'utilisent pas cette fonctionnalité.

La navigation s'effectue une fois que la personne interrogée a terminé de consulter une page qui contient l'option et uniquement si elle a choisi cette option. Si la personne interrogée a choisi plusieurs options avec des instructions de navigation sur la même page, seule la dernière option de navigation a un effet. De plus, la navigation sur les pages n'a aucune incidence sur la dernière page d'un formulaire.

Paramètres

NomTypeDescription
valueStringValeur du choix que les personnes interrogées voient sous forme de libellé lorsqu'elles consultent le formulaire
navigationTypePageNavigationTypele type de navigation du choix

Aller-retour

Choice : 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. Lève une exception si l'argument response ne correspond pas à un choix valide pour cet élément.

Paramètres

NomTypeDescription
responseStringune réponse valide pour cet élément de liste

Aller-retour

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.

Aller-retour

ListItem : doublon de 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 tous les choix possibles pour un élément.

Aller-retour

Choice[] : un tableau de 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

getFeedbackForCorrect()

Affiche les commentaires fournis aux personnes interrogées lorsqu'elles répondent correctement à une question.

Aller-retour

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()

Affiche les commentaires fournis aux personnes interrogées lorsqu'elles répondent mal à une question.

Aller-retour

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).

Aller-retour

String : texte d'aide ou description

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'article.

Aller-retour

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.

Aller-retour

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()

Affiche le barème de notation d'un élément.

Aller-retour

Integer : nombre de points gagnés par une 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

getTitle()

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

Aller-retour

String : titre ou texte de l'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 ItemType.

Aller-retour

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()

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

Aller-retour

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 d'un élément à partir d'un tableau de chaînes. Lève une exception si le tableau donné est vide.

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

Paramètres

NomTypeDescription
valuesString[]Tableau des valeurs de choix que les personnes interrogées voient sous forme de libellés lorsqu'elles consultent le formulaire

Aller-retour

ListItem : 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

setChoices(choices)

Définit un tableau de choix pour un élément. Lève 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.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?')
item.setChoices([
    item.createChoice('Cats'),
    item.createChoice('Dogs')
]);

Paramètres

NomTypeDescription
choicesChoice[]un large éventail de choix

Aller-retour

ListItem : cet élément 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.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var 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

NomTypeDescription
feedbackQuizFeedbackles nouveaux commentaires. Une valeur nulle efface le commentaire.

Aller-retour

ListItem : 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

setFeedbackForIncorrect(feedback)

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

Paramètres

NomTypeDescription
feedbackQuizFeedbackles nouveaux commentaires

Aller-retour

ListItem : 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

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

NomTypeDescription
textStringle nouveau texte d'aide

Aller-retour

ListItem : 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

setPoints(points)

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

Paramètres

NomTypeDescription
pointsIntegerle nombre de points d'une question

Aller-retour

ListItem : 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

setRequired(enabled)

Ce paramètre détermine si la personne interrogée doit répondre à la question.

Paramètres

NomTypeDescription
enabledBooleansi la personne interrogée doit répondre à la question

Aller-retour

ListItem : élément actuel (pour les chaînages)

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 élément SectionHeaderItem).

Paramètres

NomTypeDescription
titleStringle nouveau titre ou texte de l'en-tête

Aller-retour

ListItem : 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