Class RatingItem

NoteÉlément

Élément de question qui permet au répondant d'attribuer une note. Vous pouvez accéder aux éléments ou en créer à partir d'un Form. Lorsqu'ils sont utilisés dans un quiz, ces éléments sont notés.

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

// Get an existing rating item and access its properties.
const existingRatingItem = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();
const ratingScaleLevel = existingRatingItem.getRatingScaleLevel();
const ratingIcon = existingRatingItem.getRatingIcon();

// Create a new rating item.
const ratingItem = form.addRatingItem();

// Update the rating item's properties via chaining.
ratingItem.setRatingScaleLevel(7).setRatingIcon(FormApp.RatingIconType.HEART);

Méthodes

Méthode	Type renvoyé	Brève description
createResponse(response)	ItemResponse	Crée un ItemResponse pour cet élément de classification.
duplicate()	RatingItem	Crée une copie de cet élément et l'ajoute à la fin du formulaire.
getGeneralFeedback()	QuizFeedback	Renvoie les commentaires qui s'affichent auprès des personnes interrogées lorsqu'elles répondent à une question notée.
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.
getRatingIcon()	RatingIconType	Récupère l'icône choisie pour la note.
getRatingScaleLevel()	Integer	Récupère le niveau de l'échelle de la note.
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.
setGeneralFeedback(feedback)	RatingItem	Définit les commentaires à afficher aux personnes interrogées lorsqu'elles répondent à une question évaluable qui n'a pas de bonne ni de mauvaise réponse (c'est-à-dire des questions qui nécessitent une notation manuelle).
setHelpText(text)	RatingItem	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)	RatingItem	Définit le nombre de points d'un élément évaluable.
setRatingIcon(ratingIcon)	RatingItem	Définit l'icône de la classification.
setRatingScaleLevel(ratingScaleLevel)	RatingItem	Définit le niveau maximal de l'échelle d'évaluation.
setRequired(enabled)	RatingItem	Indique si la personne interrogée doit répondre à la question.
setTitle(title)	RatingItem	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

createResponse(response)

Crée un ItemResponse pour cet élément de classification.

Génère une exception de script si l'response fourni est inférieur à 1 ou supérieur à la valeur renvoyée par getRatingScaleLevel().

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

// Get an existing rating item and create a response for it.
const item = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();
const response =item.createResponse(5);

Paramètres

Nom	Type	Description
response	Integer	Réponse de valeur pour cet élément de classification.

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

RatingItem : double de cet élément RatingItem, 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

---

getGeneralFeedback()

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

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

---

getRatingIcon()

Récupère l'icône choisie pour la note.

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

// Get an existing rating item and get its rating icon.
const item = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();
const ratingIcon = item.getRatingIcon();

Renvois

RatingIconType : type d'icône de classification.

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

---

getRatingScaleLevel()

Récupère le niveau de l'échelle de la note.

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

// Get an existing rating item and get its rating scale level.
const item = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();
const ratingScaleLevel = item.getRatingScaleLevel();

Renvois

Integer : niveau de l'échelle d'évaluation.

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

---

setGeneralFeedback(feedback)

Définit les commentaires à afficher aux personnes interrogées lorsqu'elles répondent à une question évaluable qui n'a pas de bonne ni de mauvaise réponse (c'est-à-dire des questions qui nécessitent une notation manuelle).

Paramètres

Nom	Type	Description
feedback	QuizFeedback	les nouveaux commentaires

Renvois

RatingItem : RatingItem, 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

RatingItem : RatingItem, 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

RatingItem : RatingItem, 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

---

setRatingIcon(ratingIcon)

Définit l'icône de la classification.

Génère une exception de script si le type d'icône de classification n'est pas valide.

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

// Get an existing rating item and set its rating icon.
const item = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();
item.setRatingIcon(FormApp.RatingIconType.THUMB_UP);

Paramètres

Nom	Type	Description
ratingIcon	RatingIconType	Type d'icône de classification.

Renvois

RatingItem : RatingItem pour le chaînage.

Génère

Error : si le type d'icône de classification n'est pas valide

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

---

setRatingScaleLevel(ratingScaleLevel)

Définit le niveau maximal de l'échelle d'évaluation. Le niveau maximal de l'échelle de classification doit être compris entre 3 et 10 inclus. Par défaut, une nouvelle note est attribuée au niveau 3 de l'échelle d'évaluation.

Génère une exception de script si les valeurs données dépassent les limites autorisées.

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

// Get an existing rating item and set its rating scale level.
const item = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();
item.setRatingScaleLevel(7);

Paramètres

Nom	Type	Description
ratingScaleLevel	Integer	Niveau de l'échelle d'évaluation.

Renvois

RatingItem : RatingItem pour le chaînage.

Génère

Error : si le niveau de l'échelle d'évaluation n'est pas valide

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

RatingItem : é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

RatingItem : RatingItem, 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