Class ListItem

ListItem

Es una pregunta que permite que el encuestado seleccione una opción de una lista desplegable. Se puede acceder a los elementos o crearlos desde una 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 nueva opción.
createChoice(value, isCorrect)ChoiceCrea una nueva opción.
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 nueva opción 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 agrega al final del formulario.
getChoices()Choice[]Obtiene todas las opciones de un elemento.
getFeedbackForCorrect()QuizFeedbackMuestra los comentarios que ven los encuestados cuando responden correctamente a una pregunta.
getFeedbackForIncorrect()QuizFeedbackMuestra los comentarios que ven los encuestados cuando responden incorrectamente a una pregunta.
getHelpText()StringObtiene el texto de ayuda del elemento (a veces llamado texto descriptivo para los 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()IntegerMuestra la puntuación de un elemento que se puede calificar.
getTitle()StringObtiene el título del elemento (a veces llamado texto del encabezado, en el caso de SectionHeaderItem).
getType()ItemTypeObtiene el tipo del elemento, representado como ItemType.
isRequired()BooleanDetermina si el encuestado debe responder la pregunta.
setChoiceValues(values)ListItemEstablece las opciones de un elemento de un array de cadenas.
setChoices(choices)ListItemEstablece un array de opciones para un elemento.
setFeedbackForCorrect(feedback)ListItemEstablece los comentarios para que se muestren a los encuestados cuando responden correctamente a una pregunta.
setFeedbackForIncorrect(feedback)ListItemEstablece que los comentarios se muestren a los encuestados cuando respondan incorrectamente a una pregunta.
setHelpText(text)ListItemEstablece el texto de ayuda del elemento (a veces llamado texto descriptivo para elementos de diseño, como ImageItems, PageBreakItems y SectionHeaderItems).
setPoints(points)ListItemEstablece la cantidad de puntos que vale un elemento que se puede calificar.
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 nueva opción.

Parámetros

NombreTipoDescripción
valueStringel valor de la opción, que los encuestados ven como una etiqueta al ver el formulario

Devolvedor

Choice es 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 nueva opción.

Parámetros

NombreTipoDescripción
valueStringel valor de la opción, que los encuestados ven como una etiqueta al ver el formulario
isCorrectBooleansi la respuesta es correcta

Devolvedor

Choice es 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 configurado como FormApp.PageNavigationType.GO_TO_PAGE. Las opciones que usan navegación de página no se pueden combinar en el mismo elemento con opciones que no la usan.

La navegación de la página ocurre 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 tiene 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 opción, que los encuestados ven como una etiqueta al ver el formulario
navigationItemPageBreakItemel elemento en el cual navegar

Devolvedor

Choice es 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 nueva opción 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 la usan.

La navegación de la página ocurre 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 tiene 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 opción, que los encuestados ven como una etiqueta al ver el formulario
navigationTypePageNavigationTypeel tipo de navegación de la opción

Devolvedor

Choice es 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

Devolvedor

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.

Devolvedor

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

Devolvedor

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

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

Devolvedor

QuizFeedback: Es el comentario, 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 ven los encuestados cuando responden incorrectamente a una pregunta.

Devolvedor

QuizFeedback: Es el comentario, 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 descriptivo para los elementos de diseño, como ImageItems, PageBreakItems y SectionHeaderItems).

Devolvedor

String: Es el texto de ayuda o la 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.

Devolvedor

Integer: Es 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.

Devolvedor

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 que se puede calificar.

Devolvedor

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

Devolvedor

String: Es el 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 ItemType.

Devolvedor

ItemType: Es el tipo de 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.

Devolvedor

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 de un elemento de un array de cadenas. Muestra una excepción si el array dado 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 opciones, que los encuestados ven como etiquetas al visualizar el formulario

Devolvedor

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

setChoices(choices)

Establece un array de opciones para un elemento. Muestra una excepción si el array dado 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 array de opciones

Devolvedor

ListItem: Este ListItem, para encadenamiento

Arroja

Error: si el array 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 los comentarios para que se muestren a los encuestados cuando responden correctamente a 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
feedbackQuizFeedbackel nuevo feedback. Si el valor es nulo, se borrarán los comentarios.

Devolvedor

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

setFeedbackForIncorrect(feedback)

Establece que los comentarios se muestren a los encuestados cuando respondan incorrectamente a una pregunta.

Parámetros

NombreTipoDescripción
feedbackQuizFeedbackel nuevo comentario

Devolvedor

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

setHelpText(text)

Establece el texto de ayuda del elemento (a veces llamado texto descriptivo para elementos de diseño, como ImageItems, PageBreakItems y SectionHeaderItems).

Parámetros

NombreTipoDescripción
textStringel nuevo texto de ayuda

Devolvedor

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

setPoints(points)

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

Parámetros

NombreTipoDescripción
pointsIntegerla cantidad de puntos que vale una pregunta

Devolvedor

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

setRequired(enabled)

Establece si el encuestado debe responder la pregunta.

Parámetros

NombreTipoDescripción
enabledBooleansi el encuestado debe responder la pregunta

Devolvedor

ListItem: Es el elemento actual (para el 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

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

Devolvedor

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