Class CheckboxItem

Elemento de casilla de verificación

Es un elemento de pregunta que permite que el encuestado seleccione una o más casillas de verificación, así como un campo opcional de "otro". Se puede acceder a los elementos o crearlos desde un Form. Cuando se usan en un cuestionario, estos elementos se califican automáticamente. 

// Open a form by ID and add a new checkbox item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addCheckboxItem();
item.setTitle('What condiments would you like on your hot dog?')
    .setChoices([
      item.createChoice('Ketchup'),
      item.createChoice('Mustard'),
      item.createChoice('Relish'),
    ])
    .showOtherOption(true);

Métodos

MétodoTipo de datos que se muestraDescripción breve
clearValidation()CheckboxItemQuita cualquier validación de datos para este elemento de casilla de verificación.
createChoice(value)ChoiceCrea una opción nueva.
createChoice(value, isCorrect)ChoiceCrea una opción nueva.
createResponse(responses)ItemResponseCrea un ItemResponse nuevo para este elemento de casilla de verificación.
duplicate()CheckboxItemCrea 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 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 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 el valor en puntos de un elemento que se puede calificar.
getTitle()StringObtiene el título del elemento (a veces llamado texto del encabezado, en el caso de un SectionHeaderItem).
getType()ItemTypeObtiene el tipo del elemento, representado como un ItemType.
hasOtherOption()BooleanDetermina si el elemento tiene una opción "otro".
isRequired()BooleanDetermina si el encuestado debe responder la pregunta.
setChoiceValues(values)CheckboxItemEstablece las opciones de un elemento a partir de un array de cadenas.
setChoices(choices)CheckboxItemEstablece un array de opciones para un elemento.
setFeedbackForCorrect(feedback)CheckboxItemEstablece los comentarios que se mostrarán a las personas que responden cuando respondan correctamente una pregunta.
setFeedbackForIncorrect(feedback)CheckboxItemEstablece los comentarios que se mostrarán a las personas que responden cuando respondan incorrectamente una pregunta.
setHelpText(text)CheckboxItemEstablece 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)CheckboxItemEstablece la cantidad de puntos que vale un elemento que se puede calificar.
setRequired(enabled)CheckboxItemEstablece si el encuestado debe responder la pregunta.
setTitle(title)CheckboxItemEstablece el título del elemento (a veces llamado texto del encabezado, en el caso de un SectionHeaderItem).
setValidation(validation)CheckboxItemEstablece la validación de datos para este elemento de casilla de verificación.
showOtherOption(enabled)CheckboxItemEstablece si el elemento tiene una opción "otro".

Documentación detallada

clearValidation()

Quita cualquier validación de datos para este elemento de casilla de verificación.

Volver

CheckboxItem: Este CheckboxItem, para encadenar

Autorización

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

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

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: 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 ámbitos:

  • 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: 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 ámbitos:

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

createResponse(responses)

Crea un ItemResponse nuevo para este elemento de casilla de verificación. El argumento responses es un array String[] que contiene valores que se deben verificar. Genera una excepción si algún valor no coincide con una opción válida para este elemento, a menos que showOtherOption(enabled) se establezca en true.

Parámetros

NombreTipoDescripción
responsesString[]un array de respuestas válidas para este elemento de opción múltiple

Volver

ItemResponse: Es la respuesta 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 ámbitos:

  • 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

CheckboxItem: Es un duplicado de este CheckboxItem para encadenar.

Autorización

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

  • 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 ámbitos:

  • 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 los hay.

Autorización

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

  • 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 los hay.

Autorización

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

  • 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 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 ámbitos:

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

getId()

Obtiene el identificador único del artículo.

Volver

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 ámbitos:

  • 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 ámbitos:

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

getPoints()

Muestra el valor en puntos de un elemento que se puede calificar.

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 ámbitos:

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

Volver

String: Es 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 ámbitos:

  • 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 ámbitos:

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

hasOtherOption()

Determina si el elemento tiene una opción "otro".

Volver

Boolean: Es true si el elemento tiene una opción "otro"; false si no la tiene.

Autorización

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

  • 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 ámbitos:

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

setChoiceValues(values)

Establece las opciones de un elemento a partir de un array de cadenas. Arroja una excepción si el array determinado 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[]el array de valores de elección, que los encuestados ven como etiquetas cuando ven el formulario

Volver

CheckboxItem: Este CheckboxItem, para encadenar

Autorización

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

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

setChoices(choices)

Establece un array de opciones para un elemento. Genera 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

CheckboxItem: Este CheckboxItem, 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 ámbitos:

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

setFeedbackForCorrect(feedback)

Establece los comentarios que se mostrarán a las personas que responden 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. Si el valor es nulo, se borrarán los comentarios.

Volver

CheckboxItem: Este CheckboxItem, para encadenar

Autorización

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

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

setFeedbackForIncorrect(feedback)

Establece los comentarios que se mostrarán a las personas que responden cuando respondan incorrectamente una pregunta.

Parámetros

NombreTipoDescripción
feedbackQuizFeedbacklos comentarios nuevos

Volver

CheckboxItem: Este CheckboxItem, para encadenar

Autorización

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

  • 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

CheckboxItem: Este CheckboxItem, para encadenar

Autorización

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

  • 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 un elemento de pregunta

Volver

CheckboxItem: Este CheckboxItem, para encadenar

Autorización

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

  • 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

CheckboxItem: 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 ámbitos:

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

Parámetros

NombreTipoDescripción
titleStringel título o el texto del encabezado nuevos

Volver

CheckboxItem: Este CheckboxItem, para encadenar

Autorización

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

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

setValidation(validation)

Establece la validación de datos para este elemento de casilla de verificación. Si pasas un valor nulo o una validación sin llamar a ninguna función requerida, se quitará cualquier validación anterior.

Parámetros

NombreTipoDescripción
validationCheckboxValidationun elemento CheckboxValidation para aplicar a este artículo.

Volver

CheckboxItem: Este CheckboxItem, para encadenar

Autorización

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

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

showOtherOption(enabled)

Establece si el elemento tiene una opción "otro". El valor predeterminado para un CheckboxItem o MultipleChoiceItem nuevo es false.

Parámetros

NombreTipoDescripción
enabledBooleantrue si el elemento tiene una opción "otro"; false si no

Volver

CheckboxItem: Este CheckboxItem, para encadenar

Autorización

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

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