Class FormApp

FormApp

Permite que una secuencia de comandos abra un Form existente o cree uno nuevo.

// Open a form by ID.
const existingForm = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

// Create and open a form.
const newForm = FormApp.create('Form Name');

Propiedades

Propiedad	Tipo	Descripción
Alignment	Alignment	Es una enumeración de tipos de alineación de imágenes.
DestinationType	DestinationType	Es una enumeración de tipos de destinos que pueden almacenar respuestas de formularios.
FeedbackType	FeedbackType	Es una enumeración de tipos de Feedbacks de formularios.
ItemType	ItemType	Es una enumeración de tipos de Items de formularios.
PageNavigationType	PageNavigationType	Es una enumeración de comportamientos posibles para navegar por las páginas.
RatingIconType	RatingIconType	Es una enumeración de tipos de íconos de calificación RatingIcons.

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
create(title)	Form	Crea y muestra un Form nuevo.
create(title, isPublished)	Form	Crea y muestra un Form nuevo en el estado de publicación solicitado.
createCheckboxGridValidation()	CheckboxGridValidationBuilder	Muestra una instancia de CheckboxGridValidationBuilder que se puede usar para establecer la validación en un CheckboxGridItem.
createCheckboxValidation()	CheckboxValidationBuilder	Muestra una instancia de CheckboxValidationBuilder que se puede usar para establecer la validación en un CheckboxItem.
createFeedback()	QuizFeedbackBuilder	Muestra una instancia de QuizFeedbackBuilder que se puede usar para establecer comentarios en un Item calificable.
createGridValidation()	GridValidationBuilder	Muestra una instancia de GridValidationBuilder que se puede usar para establecer la validación en un GridItem.
createParagraphTextValidation()	ParagraphTextValidationBuilder	Muestra una instancia de ParagraphTextValidationBuilder que se puede usar para establecer la validación en un ParagraphTextItem.
createTextValidation()	TextValidationBuilder	Muestra una instancia de TextValidationBuilder que se puede usar para establecer la validación en un TextItem.
getActiveForm()	Form	Muestra el formulario al que está vinculada la secuencia de comandos.
getUi()	Ui	Muestra una instancia del entorno de la interfaz de usuario del editor de formularios que permite que la secuencia de comandos agregue funciones como menús, diálogos y barras laterales.
openById(id)	Form	Muestra el Form con el ID especificado.
openByUrl(url)	Form	Muestra el Form con la URL especificada.

Documentación detallada

create(title)

Crea y muestra un Form nuevo. Arroja una excepción si el título proporcionado es null o está vacío.

// Create and open a form.
const form = FormApp.create('Form Name');

Parámetros

Nombre	Tipo	Descripción
title	String	El nombre del formulario nuevo.

Volver

Form : El formulario nuevo.

Arroja

Error : Si el título proporcionado es null o está vacío

Autorización

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

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

---

create(title, isPublished)

Crea y muestra un Form nuevo en el estado de publicación solicitado. Arroja una excepción si el título proporcionado es null o está vacío.

// Create, publish and open a form.
const form = FormApp.create('Form Name', true);

Parámetros

Nombre	Tipo	Descripción
title	String	El nombre del formulario nuevo.
isPublished	Boolean	Indica si se debe publicar el formulario.

Volver

Form : El formulario nuevo.

Arroja

Error : Si el título proporcionado es null o está vacío

Autorización

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

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

---

createCheckboxGridValidation()

Muestra una instancia de CheckboxGridValidationBuilder que se puede usar para establecer la validación en un CheckboxGridItem.

Volver

CheckboxGridValidationBuilder

---

createCheckboxValidation()

Muestra una instancia de CheckboxValidationBuilder que se puede usar para establecer la validación en un CheckboxItem.

Volver

CheckboxValidationBuilder

---

createFeedback()

Muestra una instancia de QuizFeedbackBuilder que se puede usar para establecer comentarios en un Item calificable.

Volver

QuizFeedbackBuilder

---

createGridValidation()

Muestra una instancia de GridValidationBuilder que se puede usar para establecer la validación en un GridItem.

Volver

GridValidationBuilder

---

createParagraphTextValidation()

Muestra una instancia de ParagraphTextValidationBuilder que se puede usar para establecer la validación en un ParagraphTextItem.

Volver

ParagraphTextValidationBuilder

---

createTextValidation()

Muestra una instancia de TextValidationBuilder que se puede usar para establecer la validación en un TextItem.

Volver

TextValidationBuilder

---

getActiveForm()

Muestra el formulario al que está vinculada la secuencia de comandos. Para interactuar con formularios a los que no está vinculada la secuencia de comandos, usa openById(id) o openByUrl(url).

// Get the form to which this script is bound.
const form = FormApp.getActiveForm();

Volver

Form : El formulario al que está vinculada la secuencia de comandos o null si la secuencia de comandos no está vinculada a un formulario

Autorización

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

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

---

getUi()

Muestra una instancia del entorno de la interfaz de usuario del editor de formularios que permite que la secuencia de comandos agregue funciones como menús, diálogos y barras laterales. Una secuencia de comandos solo puede interactuar con la IU de la instancia actual de un editor de formularios abierto (no la vista que ve un encuestado) y solo si la secuencia de comandos está vinculada al formulario. Para obtener más información, consulta las guías de menús y diálogos y barras laterales.

// Add a custom menu to the active form, including a separator and a sub-menu.
function onOpen(e) {
  FormApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(
          FormApp.getUi()
              .createMenu('My sub-menu')
              .addItem('One sub-menu item', 'mySecondFunction')
              .addItem('Another sub-menu item', 'myThirdFunction'),
          )
      .addToUi();
}

Volver

Ui : Una instancia del entorno de la interfaz de usuario de este formulario

---

openById(id)

Muestra el Form con el ID especificado. Arroja una excepción si el ID no es válido o si el usuario no tiene permiso para abrir el formulario.

// Open a form by ID.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

Parámetros

Nombre	Tipo	Descripción
id	String	El ID del formulario que se abrirá

Volver

Form : El formulario con el ID proporcionado

Arroja

Error : Si el ID proporcionado no es válido o el usuario no tiene los permisos suficientes

Autorización

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

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

---

openByUrl(url)

Muestra el Form con la URL especificada. Arroja una excepción si la URL no es válida o si el usuario no tiene permiso para abrir el formulario.

// Open a form by URL.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit',
);

Parámetros

Nombre	Tipo	Descripción
url	String	La URL del formulario que se abrirá

Volver

Form : El formulario con la URL proporcionada

Arroja

Error : Si la URL proporcionada no es válida o el usuario no tiene los permisos suficientes

Autorización

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

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