Class RatingItem

Élément

Question permettant au répondant de donner une note. Les éléments sont accessibles ou peuvent être créés à 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éthodeType renvoyéBrève description
createResponse(response)ItemResponseCrée un ItemResponse pour cet élément de notation.
duplicate()RatingItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getGeneralFeedback()QuizFeedbackRenvoie les commentaires affichés aux participants lorsqu'ils répondent à une question pouvant être notée.
getHelpText()StringObtient 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()IntegerObtient l'identifiant unique de l'élément.
getIndex()IntegerObtient l'index de l'élément parmi tous les éléments du formulaire.
getPoints()IntegerRenvoie la valeur en points d'un élément pouvant être noté.
getRatingIcon()RatingIconTypeRécupère l'icône choisie pour la note.
getRatingScaleLevel()IntegerRécupère le niveau de l'échelle de notation.
getTitle()StringObtient le titre de l'élément (parfois appelé texte d'en-tête dans le cas d'un SectionHeaderItem).
getType()ItemTypeObtient le type de l'élément, représenté sous la forme d'un ItemType.
isRequired()BooleanDétermine si la personne interrogée doit répondre à la question.
setGeneralFeedback(feedback)RatingItemDéfinit le commentaire à afficher aux participants lorsqu'ils répondent à une question évaluable qui n'a pas de réponse correcte ou incorrecte (c'est-à-dire les questions qui nécessitent une évaluation manuelle).
setHelpText(text)RatingItemDé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)RatingItemDéfinit le nombre de points qu'un élément à noter vaut.
setRatingIcon(ratingIcon)RatingItemDéfinit l'icône de la note.
setRatingScaleLevel(ratingScaleLevel)RatingItemDéfinit le niveau maximal de l'échelle de notation.
setRequired(enabled)RatingItemIndique si la personne interrogée doit répondre à la question.
setTitle(title)RatingItemDé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 notation.

Génère une exception de script si la valeur response fournie est inférieure à 1 ou supérieure à 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

NomTypeDescription
responseIntegerRéponse de valeur pour cet élément d'évaluation.

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 scopes 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 ce RatingItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getGeneralFeedback()

Renvoie les commentaires affichés aux participants lorsqu'ils répondent à une question pouvant être notée.

Renvois

QuizFeedback : commentaire, le cas échéant.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getHelpText()

Obtient 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 description de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getId()

Obtient 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 scopes suivants :

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

getIndex()

Obtient 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 scopes suivants :

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

getPoints()

Renvoie la valeur en points d'un élément pouvant être noté.

Renvois

Integer : nombre de points attribués à une question.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 note.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getRatingScaleLevel()

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

// 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 scopes suivants :

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

getTitle()

Obtient 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 scopes suivants :

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

getType()

Obtient le type de l'élément, représenté sous la forme d'un ItemType.

Renvois

ItemType : type de l'article

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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.

Renvois

Boolean : indique si le répondant doit répondre à la question.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

setGeneralFeedback(feedback)

Définit le commentaire à afficher aux participants lorsqu'ils répondent à une question évaluable qui n'a pas de réponse correcte ou incorrecte (c'est-à-dire les questions qui nécessitent une évaluation manuelle).

Paramètres

NomTypeDescription
feedbackQuizFeedbackles 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 scopes 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 ;

Renvois

RatingItem : RatingItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 à noter vaut. La valeur par défaut pour les nouveaux éléments est 0.

Paramètres

NomTypeDescription
pointsIntegerle nombre de points qu'une question rapporte ;

Renvois

RatingItem : RatingItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

setRatingIcon(ratingIcon)

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

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

NomTypeDescription
ratingIconRatingIconTypeType d'icône de note.

Renvois

RatingItem : ce RatingItem, pour le chaînage.

Génère

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

setRatingScaleLevel(ratingScaleLevel)

Définit le niveau maximal de l'échelle de notation. Le niveau maximal de l'échelle de notation doit être compris entre 3 et 10 (inclus). Par défaut, une nouvelle note correspond au niveau 3 de l'échelle d'évaluation.

Génère une exception de script si les valeurs fournies sont en dehors des 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

NomTypeDescription
ratingScaleLevelIntegerNiveau de l'échelle d'évaluation.

Renvois

RatingItem : ce 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 scopes 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

NomTypeDescription
enabledBooleansi 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 scopes 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

NomTypeDescription
titleStringle nouveau titre ou texte d'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 scopes suivants :

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