Class RatingItem

RatingItem

Es un elemento de pregunta que permite que el encuestado proporcione una calificación. Se puede acceder a los elementos o crearlos desde un Form. Cuando se usan en un cuestionario, estos elementos se califican. 

// 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étodos

MétodoTipo de datos que se devuelveDescripción breve
createResponse(response)ItemResponseCrea un objeto ItemResponse nuevo para este elemento de calificación.
duplicate()RatingItemCrea una copia de este elemento y la agrega al final del formulario.
getGeneralFeedback()QuizFeedback|nullDevuelve los comentarios que se muestran a los encuestados cuando responden una pregunta calificable.
getHelpText()StringObtiene el texto de ayuda del elemento (a veces, se denomina texto de descripción para elementos de diseño como ImageItems, PageBreakItems y SectionHeaderItems).
getId()IntegerObtiene el identificador único del elemento.
getIndex()IntegerObtiene el índice del elemento entre todos los elementos del formulario.
getPoints()IntegerDevuelve el valor de puntos de un elemento calificable.
getRatingIcon()RatingIconTypeObtiene el ícono elegido para la calificación.
getRatingScaleLevel()IntegerObtiene el nivel de la escala de calificación.
getTitle()StringObtiene el título del elemento (a veces, se denomina texto del encabezado, en el caso de un SectionHeaderItem).
getType()ItemTypeObtiene el tipo del elemento, representado como un ItemType.
isRequired()BooleanDetermina si el encuestado debe responder la pregunta.
setGeneralFeedback(feedback)RatingItemEstablece los comentarios que se mostrarán a los encuestados cuando respondan una pregunta calificable que no tenga una respuesta correcta o incorrecta (es decir, preguntas que requieren calificación manual).
setHelpText(text)RatingItemEstablece el texto de ayuda del elemento (a veces, se denomina texto de descripción para elementos de diseño como ImageItems, PageBreakItems y SectionHeaderItems).
setPoints(points)RatingItemEstablece la cantidad de puntos que vale un elemento calificable.
setRatingIcon(ratingIcon)RatingItemEstablece el ícono de la calificación.
setRatingScaleLevel(ratingScaleLevel)RatingItemEstablece el nivel máximo de la escala de calificación.
setRequired(enabled)RatingItemEstablece si el encuestado debe responder la pregunta.
setTitle(title)RatingItemEstablece el título del elemento (a veces, se denomina texto del encabezado, en el caso de un SectionHeaderItem).

Documentación detallada

createResponse(response)

Crea un objeto ItemResponse nuevo para este elemento de calificación.

Genera una excepción de secuencias de comandos si el response proporcionado es menor que 1 o mayor que el valor que devuelve 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);

Parámetros

NombreTipoDescripción
responseIntegerEs una respuesta de valor para este elemento de calificación.

Volver

ItemResponse: Es la respuesta del elemento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

duplicate()

Crea una copia de este elemento y la agrega al final del formulario.

Volver

RatingItem: Es un duplicado de este RatingItem para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getGeneralFeedback()

Devuelve los comentarios que se muestran a los encuestados cuando responden una pregunta calificable.

Volver

QuizFeedback|null: Es la opinión, si la hay.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getHelpText()

Obtiene el texto de ayuda del elemento (a veces, se denomina texto de descripción para elementos de diseño como ImageItems, PageBreakItems y SectionHeaderItems).

Volver

String: Texto de ayuda o descripción del elemento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getId()

Obtiene el identificador único del elemento.

Volver

Integer: Es el ID del elemento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getIndex()

Obtiene el índice del elemento entre todos los elementos del formulario.

Volver

Integer: Es el índice del elemento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getPoints()

Devuelve el valor de puntos de un elemento calificable.

Volver

Integer: Es la cantidad de puntos que vale una pregunta.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getRatingIcon()

Obtiene el ícono elegido para la calificación. 

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

Volver

RatingIconType: Es el tipo de ícono de calificación.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getRatingScaleLevel()

Obtiene el nivel de la escala de calificación. 

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

Volver

Integer: Es el nivel de la escala de calificación.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getTitle()

Obtiene el título del elemento (a veces, se denomina texto del encabezado, en el caso de un SectionHeaderItem).

Volver

String: Título o texto del encabezado del elemento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getType()

Obtiene el tipo del elemento, representado como un ItemType.

Volver

ItemType: Es el tipo del elemento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

isRequired()

Determina si el encuestado debe responder la pregunta.

Volver

Boolean: Indica si el encuestado debe responder la pregunta.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setGeneralFeedback(feedback)

Establece los comentarios que se mostrarán a los encuestados cuando respondan una pregunta calificable que no tenga una respuesta correcta o incorrecta (es decir, preguntas que requieren calificación manual).

Parámetros

NombreTipoDescripción
feedbackQuizFeedbacklos comentarios nuevos

Volver

RatingItem: Este RatingItem, para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setHelpText(text)

Establece el texto de ayuda del elemento (a veces, se denomina texto de descripción para elementos de diseño como ImageItems, PageBreakItems y SectionHeaderItems).

Parámetros

NombreTipoDescripción
textStringEl nuevo texto de ayuda

Volver

RatingItem: Este RatingItem, para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setPoints(points)

Establece la cantidad de puntos que vale un elemento calificable. El valor predeterminado para los elementos nuevos es 0.

Parámetros

NombreTipoDescripción
pointsIntegerLa cantidad de puntos que vale un elemento de pregunta

Volver

RatingItem: Este RatingItem, para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setRatingIcon(ratingIcon)

Establece el ícono de la calificación.

Arroja una excepción de secuencia de comandos si el tipo de ícono de calificación no es válido. 

// 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);

Parámetros

NombreTipoDescripción
ratingIconRatingIconTypeEs el tipo de ícono de calificación.

Volver

RatingItem: Este RatingItem, para el encadenamiento.

Arroja

Error: Si el tipo de ícono de calificación no es válido

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setRatingScaleLevel(ratingScaleLevel)

Establece el nivel máximo de la escala de calificación. El nivel máximo de la escala de calificación debe estar entre 3 y 10, ambos incluidos. Una nueva calificación se establece de forma predeterminada en un nivel de escala de calificación de 3.

Arroja una excepción de secuencias de comandos si los valores proporcionados están fuera de los límites permitidos. 

// 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);

Parámetros

NombreTipoDescripción
ratingScaleLevelIntegerEs el nivel de la escala de calificación.

Volver

RatingItem: Este RatingItem, para el encadenamiento.

Arroja

Error: Si el nivel de la escala de calificación no es válido

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setRequired(enabled)

Establece si el encuestado debe responder la pregunta.

Parámetros

NombreTipoDescripción
enabledBooleanSi el encuestado debe responder la pregunta

Volver

RatingItem: Es el elemento actual (para encadenar).

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setTitle(title)

Establece el título del elemento (a veces, se denomina texto del encabezado, en el caso de un SectionHeaderItem).

Parámetros

NombreTipoDescripción
titleStringEl nuevo título o texto del encabezado

Volver

RatingItem: Este RatingItem, para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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