Interface Item

Elemento

Es un elemento de formulario genérico que contiene propiedades comunes a todos los elementos, como el título y el texto de ayuda. Se puede acceder a los elementos o crearlos desde una Form.

Para operar en propiedades específicas de tipo, usa getType() a fin de verificar el ItemType del elemento y, luego, transmite el elemento a la clase adecuada con un método como asCheckboxItem().

// Create a new form and add a text item.
var form = FormApp.create('Form Name');
form.addTextItem();

// Access the text item as a generic item.
var items = form.getItems();
var item = items[0];

// Cast the generic item to the text-item class.
if (item.getType() == 'TEXT') {
  var textItem = item.asTextItem();
  textItem.setRequired(false);
}

Cómo implementar clases

NombreDescripción breve

Métodos

MétodoTipo de datos que se muestraDescripción breve
asCheckboxGridItem()CheckboxGridItemMuestra el elemento como un elemento de la cuadrícula de la casilla de verificación.
asCheckboxItem()CheckboxItemMuestra el elemento como un elemento de casilla de verificación.
asDateItem()DateItemMuestra el elemento como un elemento de fecha.
asDateTimeItem()DateTimeItemMuestra el elemento como un elemento de fecha y hora.
asDurationItem()DurationItemMuestra el elemento como un elemento de duración.
asGridItem()GridItemMuestra el elemento como un elemento de la cuadrícula.
asImageItem()ImageItemMuestra el elemento como un elemento de imagen.
asListItem()ListItemMuestra el elemento como un elemento de lista.
asMultipleChoiceItem()MultipleChoiceItemMuestra el elemento como un elemento de opción múltiple.
asPageBreakItem()PageBreakItemMuestra el elemento como un elemento de salto de página.
asParagraphTextItem()ParagraphTextItemMuestra el elemento como un elemento de texto y párrafo.
asScaleItem()ScaleItemMuestra el elemento como un elemento de escala.
asSectionHeaderItem()SectionHeaderItemMuestra el elemento como un elemento de encabezado de sección.
asTextItem()TextItemMuestra el elemento como un elemento de texto.
asTimeItem()TimeItemMuestra el elemento como un elemento de tiempo.
asVideoItem()VideoItemMuestra el elemento como un elemento de video.
duplicate()ItemCrea una copia de este elemento y la agrega al final del formulario.
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.
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.
setHelpText(text)ItemEstablece el texto de ayuda del elemento (a veces llamado texto descriptivo para elementos de diseño, como ImageItems, PageBreakItems y SectionHeaderItems).
setTitle(title)ItemEstablece el título del elemento (a veces llamado texto de encabezado, en el caso de SectionHeaderItem).

Documentación detallada

asCheckboxGridItem()

Muestra el elemento como un elemento de la cuadrícula de la casilla de verificación. Muestra una excepción de secuencia de comandos si el ItemType no era CHECKBOX_GRID.

Devolvedor

CheckboxGridItem: Es el elemento de cuadrícula de la casilla de verificación.

Arroja

Error: Si el elemento no es un elemento de la cuadrícula de la casilla de verificació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

asCheckboxItem()

Muestra el elemento como un elemento de casilla de verificación. Muestra una excepción de secuencia de comandos si el ItemType no era CHECKBOX.

Devolvedor

CheckboxItem: Es el elemento de la casilla de verificación.

Arroja

Error: Si el elemento no es un elemento de casilla de verificació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

asDateItem()

Muestra el elemento como un elemento de fecha. Muestra una excepción de secuencia de comandos si el ItemType no era DATE.

Devolvedor

DateItem: Es el elemento de la fecha.

Arroja

Error: Si el elemento no es un elemento de fecha.

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

asDateTimeItem()

Muestra el elemento como un elemento de fecha y hora. Muestra una excepción de secuencia de comandos si el ItemType no era DATETIME.

Devolvedor

DateTimeItem: Es el elemento de fecha y hora.

Arroja

Error: Si el elemento no es un elemento de fecha y hora.

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

asDurationItem()

Muestra el elemento como un elemento de duración. Muestra una excepción de secuencia de comandos si el ItemType no era DURATION.

Devolvedor

DurationItem: Es el elemento de duración.

Arroja

Error: Si el elemento no es de duració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

asGridItem()

Muestra el elemento como un elemento de la cuadrícula. Muestra una excepción de secuencia de comandos si el ItemType no era GRID.

Devolvedor

GridItem: Es el elemento de la cuadrícula.

Arroja

Error: Si el elemento no es un elemento de cuadrícula.

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

asImageItem()

Muestra el elemento como un elemento de imagen. Muestra una excepción de secuencia de comandos si el ItemType no era IMAGE.

Devolvedor

ImageItem: Es el elemento de la imagen.

Arroja

Error: Si el elemento no es un elemento de imagen.


asListItem()

Muestra el elemento como un elemento de lista. Muestra una excepción de secuencia de comandos si el ItemType no era LIST.

Devolvedor

ListItem: Es el elemento de la lista.

Arroja

Error: Si el elemento no es un elemento de la lista.

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

asMultipleChoiceItem()

Muestra el elemento como un elemento de opción múltiple. Muestra una excepción de secuencia de comandos si el ItemType no era MULTIPLE_CHOICE.

Devolvedor

MultipleChoiceItem: Es el elemento de opción múltiple.

Arroja

Error: Si el elemento no es de opción múltiple.

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

asPageBreakItem()

Muestra el elemento como un elemento de salto de página. Muestra una excepción de secuencia de comandos si el ItemType no era PAGE_BREAK.

Devolvedor

PageBreakItem: Es el elemento de salto de página.

Arroja

Error: Si el elemento no es un elemento de salto de página.

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

asParagraphTextItem()

Muestra el elemento como un elemento de texto y párrafo. Muestra una excepción de secuencia de comandos si el ItemType no era PARAGRAPH_TEXT.

Devolvedor

ParagraphTextItem: Es el elemento de texto del párrafo.

Arroja

Error: Si el elemento no es un elemento de texto de párrafo.

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

asScaleItem()

Muestra el elemento como un elemento de escala. Muestra una excepción de secuencia de comandos si el ItemType no era SCALE.

Devolvedor

ScaleItem: Es el elemento de escala.

Arroja

Error: si el elemento no es un elemento de escala

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

asSectionHeaderItem()

Muestra el elemento como un elemento de encabezado de sección. Muestra una excepción de secuencia de comandos si el ItemType no era SECTION_HEADER.

Devolvedor

SectionHeaderItem: Es el elemento de encabezado de la sección.

Arroja

Error: Si el elemento no es un elemento de encabezado de secció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

asTextItem()

Muestra el elemento como un elemento de texto. Muestra una excepción de secuencia de comandos si el ItemType no era TEXT.

Devolvedor

TextItem: Es el elemento de texto.

Arroja

Error: Si el elemento no es de texto.

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

asTimeItem()

Muestra el elemento como un elemento de tiempo. Muestra una excepción de secuencia de comandos si el ItemType no era TIME.

Devolvedor

TimeItem: Es el elemento de tiempo.

Arroja

Error: Si el elemento no es un elemento de tiempo.

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

asVideoItem()

Muestra el elemento como un elemento de video. Muestra una excepción de secuencia de comandos si el ItemType no era VIDEO.

Devolvedor

VideoItem: Es el elemento de video.

Arroja

Error: Si el elemento no es un elemento de video.


duplicate()

Crea una copia de este elemento y la agrega al final del formulario.

Devolvedor

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

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

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

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

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

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

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