Class ListItem

ListItem

Una pregunta que permite al encuestado seleccionar una opción de una lista desplegable. Los elementos pueden se puede acceder a ellos o se crean 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 nueva opción 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 ItemResponse nuevo para este elemento de 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()QuizFeedbackDevuelve el feedback que se muestra a los encuestados cuando responden correctamente a una pregunta.
getFeedbackForIncorrect()QuizFeedbackDevuelve el feedback que se muestra a los encuestados cuando responden una pregunta de forma incorrecta.
getHelpText()StringObtiene el texto de ayuda del elemento (a veces llamado 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()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 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 a una pregunta.
setFeedbackForIncorrect(feedback)ListItemPermite mostrar los comentarios a los encuestados cuando responden una pregunta de forma incorrecta.
setHelpText(text)ListItemEstablece el texto de ayuda del elemento (a veces llamado 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 con calificación.
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 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 verán como una etiqueta al revisar 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 verán como una etiqueta al revisar 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 nueva opción con una opción de navegación de página que salta a un elemento de salto de página determinado. Esta equivale a createChoice(value, navigationType) con navigationType establecido en FormApp.PageNavigationType.GO_TO_PAGE. Opciones que usan la página la navegación no se puede combinar en el mismo elemento con opciones que no usan la navegación de páginas.

La navegación por 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áginas en la misma página, solo la última opción de navegación tiene efecto. La navegación de páginas tampoco afecta la última página de un formulario.

Parámetros

NombreTipoDescripción
valueStringel valor de la opción, que los encuestados verán como una etiqueta al revisar 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 pueden se combinan en el mismo elemento con opciones que no usan la navegación de páginas.

La navegación por 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áginas en la misma página, solo la última opción de navegación tiene efecto. La navegación de páginas tampoco afecta la última página de un formulario.

Parámetros

NombreTipoDescripción
valueStringel valor de la opción, que los encuestados verán como una etiqueta al revisar 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 ItemResponse nuevo para este elemento de 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 agrega al final del formulario.

Volver

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

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 el feedback que se muestra a los encuestados cuando responden correctamente a una pregunta.

Volver

QuizFeedback: Son 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()

Devuelve el feedback que se muestra a los encuestados cuando responden una pregunta de forma incorrecta.

Volver

QuizFeedback: Son 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 elementos de diseño como ImageItems, PageBreakItems y SectionHeaderItems).

Volver

String: Es el 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()

Muestra la puntuación 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 llamado texto de encabezado, en el caso de un SectionHeaderItem).

Volver

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 un ItemType.

Volver

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.

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. 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[]el array de valores de opción, que los encuestados ven como etiquetas cuando ven el formulario.

Volver

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

Volver

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 que se mostrarán a los encuestados cuando respondan 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. Un valor nulo borrará los comentarios.

Volver

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)

Permite mostrar los comentarios a los encuestados cuando responden una pregunta de forma incorrecta.

Parámetros

NombreTipoDescripción
feedbackQuizFeedbackel nuevo comentario

Volver

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 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 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 con calificación. 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 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

Volver

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 un SectionHeaderItem).

Parámetros

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

Volver

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