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, convierte el elemento a la clase apropiada 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);
}

Implementación de clases

NombreDescripción breve

Métodos

MétodoTipo de datos que se devuelveDescripción breve
asCheckboxGridItem()CheckboxGridItemDevuelve el elemento como un elemento de cuadrícula de casillas de verificación.
asCheckboxItem()CheckboxItemDevuelve el elemento como un elemento de casilla de verificación.
asDateItem()DateItemDevuelve el elemento como un elemento de fecha.
asDateTimeItem()DateTimeItemDevuelve el elemento como un elemento de fecha y hora.
asDurationItem()DurationItemDevuelve el elemento como un elemento de duración.
asGridItem()GridItemDevuelve el elemento como un elemento de cuadrícula.
asImageItem()ImageItemDevuelve el elemento como un elemento de imagen.
asListItem()ListItemDevuelve el elemento como un elemento de lista.
asMultipleChoiceItem()MultipleChoiceItemDevuelve el elemento como un elemento de opción múltiple.
asPageBreakItem()PageBreakItemDevuelve el elemento como un elemento de salto de página.
asParagraphTextItem()ParagraphTextItemDevuelve el elemento como un elemento de texto de párrafo.
asRatingItem()RatingItemDevuelve el elemento como un elemento de calificación.
asScaleItem()ScaleItemDevuelve el elemento como un elemento de escala.
asSectionHeaderItem()SectionHeaderItemDevuelve el elemento como un elemento de encabezado de sección.
asTextItem()TextItemDevuelve el elemento como un elemento de texto.
asTimeItem()TimeItemDevuelve el elemento como un elemento de tiempo.
asVideoItem()VideoItemDevuelve 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, se denomina 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.
getTitle()StringObtiene el título del elemento (a veces, se denomina 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, se denomina texto de descripción para elementos de diseño como ImageItems, PageBreakItems y SectionHeaderItems).
setTitle(title)ItemEstablece el título del elemento (a veces, se denomina texto del encabezado, en el caso de un SectionHeaderItem).

Documentación detallada

asCheckboxGridItem()

Devuelve el elemento como un elemento de cuadrícula de casillas de verificación. Arroja una excepción de secuencia de comandos si el ItemType no era CHECKBOX_GRID.

Volver

CheckboxGridItem: El elemento de 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 alcances:

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

asCheckboxItem()

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

Volver

CheckboxItem: El elemento de 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 alcances:

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

asDateItem()

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

Volver

DateItem: 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 alcances:

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

asDateTimeItem()

Devuelve el elemento como un elemento de fecha y hora. Arroja una excepción de secuencia 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 alcances:

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

asDurationItem()

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

Volver

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

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

Volver

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

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

Volver

ImageItem: El elemento de imagen

Arroja

Error: Si el elemento no es un elemento de imagen

asListItem()

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

Volver

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

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

asMultipleChoiceItem()

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

Volver

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

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

Volver

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

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

Volver

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

asRatingItem()

Devuelve el elemento como un elemento de calificación. Muestra una excepción ScriptingException si ItemType no era RATING. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Fetch any item which is of type rating.
const item = form.getItems(FormApp.ItemType.RATING)[0];

// Convert the item to a rating item.
const ratingItem = item.asRatingItem();

Volver

RatingItem: Es el elemento de calificación.

Arroja

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

asScaleItem()

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

Volver

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

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

Volver

SectionHeaderItem: Es el elemento del 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()

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

Volver

TextItem: 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 alcances:

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

asTimeItem()

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

Volver

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

Devuelve el elemento como un elemento de video. Arroja 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 alcances:

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

getHelpText()

Obtiene el texto de ayuda del elemento (a veces, se denomina texto de descripción para elementos de diseño como ImageItems, PageBreakItems y SectionHeaderItems).

Volver

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

getTitle()

Obtiene el título del elemento (a veces, se denomina texto del encabezado, en el caso de un SectionHeaderItem).

Volver

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

setHelpText(text)

Establece el texto de ayuda del elemento (a veces, se denomina 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 alcances:

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

setTitle(title)

Establece el título del elemento (a veces, se denomina texto del encabezado, en el caso de un SectionHeaderItem).

Parámetros

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

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

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