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

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

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

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

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

Implementa clases

NombreDescripción breve

Métodos

MétodoTipo de datos que se muestraDescripción breve
asCheckboxGridItem()CheckboxGridItemMuestra el elemento como un elemento de cuadrícula de casilla de verificación.
asCheckboxItem()CheckboxItemMuestra el elemento como una 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 cuadrícula.
asImageItem()ImageItemDevuelve el elemento como un elemento de imagen.
asListItem()ListItemMuestra el elemento como un elemento de lista.
asMultipleChoiceItem()MultipleChoiceItemMuestra el elemento como uno 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 de 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 hora.
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 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.
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.
setHelpText(text)ItemEstablece el texto de ayuda del elemento (a veces llamado texto de descripción para elementos de diseño como ImageItems, PageBreakItems y SectionHeaderItems).
setTitle(title)ItemEstablece el título del elemento (a veces llamado texto del encabezado, en el caso de un SectionHeaderItem).

Documentación detallada

asCheckboxGridItem()

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

Volver

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

Arroja

Error: Si el elemento no es un elemento de cuadrícula de casillas 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 ámbitos:

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

asCheckboxItem()

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

Volver

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

Arroja

Error: Si el elemento no es una 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 ámbitos:

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

asDateItem()

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

Volver

DateItem: Es el elemento de 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 ámbitos:

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

asDateTimeItem()

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

Volver

DateTimeItem: Es el elemento de fecha y hora.

Arroja

Error: Si el elemento no es 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 ámbitos:

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

asDurationItem()

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

Volver

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

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

asGridItem()

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

Volver

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

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

asImageItem()

Devuelve el elemento como un elemento de imagen. Genera una excepción de secuencias de comandos si el ItemType no era IMAGE.

Volver

ImageItem: Es el elemento de imagen.

Arroja

Error: Si el elemento no es un elemento de imagen


asListItem()

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

Volver

ListItem: Es el elemento de la lista.

Arroja

Error: Si el elemento no es un elemento de lista

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

asMultipleChoiceItem()

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

Volver

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

  • 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. Genera una excepción de secuencias de comandos si el ItemType no era PAGE_BREAK.

Volver

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

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

asParagraphTextItem()

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

Volver

ParagraphTextItem: Es el elemento de texto de 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 ámbitos:

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

asScaleItem()

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

Volver

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

  • 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. Genera una excepción de secuencias de comandos si el ItemType no era SECTION_HEADER.

Volver

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

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

asTextItem()

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

Volver

TextItem: Es el elemento de texto.

Arroja

Error: Si el elemento no es un elemento de texto

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

asTimeItem()

Muestra el elemento como un elemento de hora. Genera una excepción de secuencias de comandos si el ItemType no era TIME.

Volver

TimeItem: Es el elemento de hora.

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

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

asVideoItem()

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

Volver

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.

Volver

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

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

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

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

Item: Este Item, 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 texto del título o encabezado nuevo

Volver

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