Class ListItem

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.
ListItem

Un elemento de pregunta que permite que el encuestado seleccione 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.
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é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 determinado de salto de página.
createChoice(value, navigationType)ChoiceCrea una opción nueva con una opción de navegación de página.
createResponse(response)ItemResponseCrea un ItemResponse nuevo para este elemento de la lista.
duplicate()ListItemCrea una copia de este elemento y la adjunta al final del formulario.
getChoices()Choice[]Obtiene todas las opciones de un elemento.
getFeedbackForCorrect()QuizFeedbackMuestra los comentarios que se muestran a los encuestados cuando responden correctamente una pregunta.
getFeedbackForIncorrect()QuizFeedbackMuestra los comentarios que se muestran a los encuestados cuando responden incorrectamente una pregunta.
getHelpText()StringObtiene el texto de ayuda del elemento (a veces llamado texto de descripción para los elementos de diseño, como ImageItems, PageBreakItems y SectionHeaderItems).
getId()IntegerObtiene el identificador único del artículo.
getIndex()IntegerObtiene el índice del elemento entre todos los elementos del formulario.
getPoints()IntegerMuestra la puntuación de un elemento calificable.
getTitle()StringObtiene el título del elemento (a veces llamado texto de encabezado, en el caso de un SectionHeaderItem).
getType()ItemTypeObtiene el tipo del elemento, representado como ItemType.
isRequired()BooleanDetermina si el encuestado debe responder la pregunta.
setChoiceValues(values)ListItemEstablece las opciones para un elemento a partir de un arreglo de strings.
setChoices(choices)ListItemEstablece una selección de opciones para un elemento.
setFeedbackForCorrect(feedback)ListItemEstablece que los comentarios se muestren 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 llamado texto de descripción para los elementos de diseño, como ImageItems, PageBreakItems y SectionHeaderItems).
setPoints(points)ListItemEstablece la cantidad de puntos que vale un elemento calificado.
setRequired(enabled)ListItemEstablece si el encuestado debe responder la pregunta.
setTitle(title)ListItemEstablece el título del elemento (a veces llamado texto de encabezado, en el caso de SectionHeaderItem).

Documentación detallada

createChoice(value)

Crea una opción nueva.

Parámetros

NombreTipoDescripción
valueStringel valor de la elección, que los encuestados consideran una etiqueta cuando consultan 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 elección, que los encuestados consideran una etiqueta cuando consultan el formulario
isCorrectBooleansi la elecció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 determinado de salto de página. Esto equivale a createChoice(value, navigationType) con navigationType establecido en FormApp.PageNavigationType.GO_TO_PAGE. Las opciones que usan la navegación de páginas no se pueden combinar en el mismo elemento con las opciones que no utilizan esta función.

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 el encuestado 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áginas tampoco tiene efecto en la última página de un formulario.

Parámetros

NombreTipoDescripción
valueStringel valor de la elección, que los encuestados consideran una etiqueta cuando consultan el formulario
navigationItemPageBreakItemel elemento al que 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 opciones que no utilizan esta función.

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 el encuestado 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áginas tampoco tiene efecto en la última página de un formulario.

Parámetros

NombreTipoDescripción
valueStringel valor de la elección, que los encuestados consideran una etiqueta cuando consultan el formulario
navigationTypePageNavigationTypeel tipo de navegación de la elecció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 ItemResponse nuevo para este elemento de la lista. Muestra 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: 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 adjunta al final del formulario.

Volver

ListItem: Es un duplicado de 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

getChoices()

Obtiene todas las opciones de un elemento.

Volver

Choice[]: Es un arreglo 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()

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

Volver

QuizFeedback: Los comentarios, si corresponde.

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

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

Volver

QuizFeedback: Los comentarios, si corresponde.

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 llamado texto de descripción para los elementos de diseño, como ImageItems, PageBreakItems y SectionHeaderItems).

Volver

String: el texto de ayuda o el texto de 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 artículo.

Volver

Integer: el ID del artículo

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

Muestra la puntuación de un elemento calificable.

Volver

Integer: 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 llamado texto de encabezado, en el caso de un SectionHeaderItem).

Volver

String: el título o el 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 ItemType.

Volver

ItemType: 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 arreglo de strings. Genera una excepción si el arreglo está vacío.

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

Parámetros

NombreTipoDescripción
valuesString[]la matriz de valores de las opciones, que los encuestados consideran etiquetas al visualizar 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 una selección de opciones para un elemento. Genera una excepción si el arreglo determinado está vacío o contiene un elemento 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')
]);

Parámetros

NombreTipoDescripción
choicesChoice[]un arreglo de opciones

Volver

ListItem: este ListItem, para encadenar

Arroja

Error: Si el arreglo dado 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 que los comentarios se muestren a los encuestados cuando respondan correctamente una pregunta.

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

Parámetros

NombreTipoDescripción
feedbackQuizFeedbacklos nuevos comentarios. 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 nuevos 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

setHelpText(text)

Establece el texto de ayuda del elemento (a veces llamado texto de descripción para los 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 calificado. El valor predeterminado para los elementos nuevos es 0.

Parámetros

NombreTipoDescripción
pointsIntegerla cantidad de puntos que vale un elemento de una 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 llamado texto de encabezado, en el caso de 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