Class ListItem

ListItem

Es un elemento de pregunta que permite al encuestado seleccionar una opción de una lista desplegable. Se puede acceder a los elementos o crearlos desde 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étodos

MétodoTipo de datos que se muestraDescripción breve
createChoice(value)ChoiceCrea una opción nueva.
createChoice(value, isCorrect)ChoiceCrea una opción nueva.
createChoice(value, navigationItem)ChoiceCrea una opción nueva con una opción de navegación de página que salta a un elemento de salto de página determinado.
createChoice(value, navigationType)ChoiceCrea una opción nueva con una opción de navegación de página.
createResponse(response)ItemResponseCrea un objeto ItemResponse nuevo para este elemento de la lista.
duplicate()ListItemCrea una copia de este elemento y la agrega al final del formulario.
getChoices()Choice[]Obtiene todas las opciones de un elemento.
getFeedbackForCorrect()QuizFeedback|nullDevuelve los comentarios que se muestran a los encuestados cuando responden correctamente una pregunta.
getFeedbackForIncorrect()QuizFeedback|nullDevuelve los comentarios que se muestran a los encuestados cuando responden incorrectamente una pregunta.
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.
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.
setChoiceValues(values)ListItemEstablece las opciones para un elemento a partir de un array de cadenas.
setChoices(choices)ListItemEstablece un array de opciones para un elemento.
setFeedbackForCorrect(feedback)ListItemEstablece los comentarios que se mostrarán a los encuestados cuando respondan correctamente una pregunta.
setFeedbackForIncorrect(feedback)ListItemEstablece los comentarios que se mostrarán a los encuestados cuando respondan incorrectamente una pregunta.
setHelpText(text)ListItemEstablece 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)ListItemEstablece la cantidad de puntos que vale un elemento calificable.
setRequired(enabled)ListItemEstablece si el encuestado debe responder la pregunta.
setTitle(title)ListItemEstablece el título del elemento (a veces, se denomina texto del encabezado, en el caso de un SectionHeaderItem).

Documentación detallada

createChoice(value)

Crea una opción nueva.

Parámetros

NombreTipoDescripción
valueStringEl valor de la opción, que los encuestados ven como una etiqueta cuando ven el formulario

Volver

Choice: La nueva opció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

createChoice(value, isCorrect)

Crea una opción nueva.

Parámetros

NombreTipoDescripción
valueStringEl valor de la opción, que los encuestados ven como una etiqueta cuando ven el formulario
isCorrectBooleanSi la opción es una respuesta correcta

Volver

Choice: La nueva opció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

createChoice(value, navigationItem)

Crea una opción nueva con una opción de navegación de página que salta a un elemento de salto de página determinado. Esto equivale a createChoice(value, navigationType) con navigationType establecido en FormApp.PageNavigationType.GO_TO_PAGE. Las opciones que usan la navegación de página no se pueden combinar en el mismo elemento con las opciones que no usan la navegación de página.

La navegación de la página se produce después de que el encuestado completa una página que contiene la opción y solo si el encuestado eligió esa opción. Si la persona que responde eligió varias opciones con instrucciones de navegación de página en la misma página, solo la última opción de navegación tendrá efecto. La navegación de página tampoco tiene efecto en la última página de un formulario.

Parámetros

NombreTipoDescripción
valueStringEl valor de la opción, que los encuestados ven como una etiqueta cuando ven el formulario
navigationItemPageBreakItemEl elemento al que se navegará

Volver

Choice: La nueva opció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

createChoice(value, navigationType)

Crea una opción nueva con una opción de navegación de página. Las opciones que usan la navegación de páginas no se pueden combinar en el mismo elemento con las opciones que no usan la navegación de páginas.

La navegación de la página se produce después de que el encuestado completa una página que contiene la opción y solo si el encuestado eligió esa opción. Si la persona que responde eligió varias opciones con instrucciones de navegación de página en la misma página, solo la última opción de navegación tendrá efecto. La navegación de página tampoco tiene efecto en la última página de un formulario.

Parámetros

NombreTipoDescripción
valueStringEl valor de la opción, que los encuestados ven como una etiqueta cuando ven el formulario
navigationTypePageNavigationTypeEl tipo de navegación de la opción

Volver

Choice: La nueva opció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

createResponse(response)

Crea un objeto ItemResponse nuevo para este elemento de la lista. Arroja una excepción si el argumento response no coincide con una opción válida para este elemento.

Parámetros

NombreTipoDescripción
responseStringUna respuesta válida para este elemento de la lista

Volver

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

ListItem: Duplicado de este ListItem, para encadenamiento

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

getChoices()

Obtiene todas las opciones de un elemento.

Volver

Choice[]: Es un array de opciones.

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

getFeedbackForCorrect()

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

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

getFeedbackForIncorrect()

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

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

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

setChoiceValues(values)

Establece las opciones para un elemento a partir de un array de cadenas. Arroja una excepción si el array proporcionado está vacío. 

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

Parámetros

NombreTipoDescripción
valuesString[]Es el array de valores de opción, que los encuestados ven como etiquetas cuando visualizan el formulario.

Volver

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

setChoices(choices)

Establece un array de opciones para un elemento. Arroja una excepción si el array proporcionado está vacío o contiene un elemento 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')]);

Parámetros

NombreTipoDescripción
choicesChoice[]Un array de opciones

Volver

ListItem: Este ListItem, para encadenar

Arroja

Error: Si el array proporcionado es null, está vacío o contiene un elemento null

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

setFeedbackForCorrect(feedback)

Establece los comentarios que se mostrarán a los encuestados cuando respondan correctamente una pregunta. 

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

Parámetros

NombreTipoDescripción
feedbackQuizFeedbacklos comentarios nuevos. Un valor nulo borrará los comentarios.

Volver

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

setFeedbackForIncorrect(feedback)

Establece los comentarios que se mostrarán a los encuestados cuando respondan incorrectamente una pregunta.

Parámetros

NombreTipoDescripción
feedbackQuizFeedbacklos comentarios nuevos

Volver

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

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

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

setRequired(enabled)

Establece si el encuestado debe responder la pregunta.

Parámetros

NombreTipoDescripción
enabledBooleanSi el encuestado debe responder la pregunta

Volver

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

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