Class FormApp

FormApp

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

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

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

Propiedades

PropiedadTipoDescripción
AlignmentAlignmentUna enumeración de los tipos de alineación de imagen.
DestinationTypeDestinationTypeUna enumeración de los tipos de destinos que pueden almacenar respuestas del formulario.
FeedbackTypeFeedbackTypeUna enumeración de los tipos del formulario Feedbacks.
ItemTypeItemTypeUna enumeración de los tipos del formulario Items.
PageNavigationTypePageNavigationTypeUna enumeración de los posibles comportamientos para navegar por las páginas.

Métodos

MétodoTipo de datos que se muestraDescripción breve
create(title)FormCrea y muestra un Form nuevo.
createCheckboxGridValidation()CheckboxGridValidationBuilderDevuelve una instancia de CheckboxGridValidationBuilder que puede usarse para establecer la validación en un CheckboxGridItem
createCheckboxValidation()CheckboxValidationBuilderDevuelve una instancia de CheckboxValidationBuilder que se puede usar para establecer la validación en un CheckboxItem
createFeedback()QuizFeedbackBuilderDevuelve una instancia de QuizFeedbackBuilder que se puede usar para establecer comentarios sobre una calificación Item
createGridValidation()GridValidationBuilderMuestra una instancia de GridValidationBuilder que se puede usar para establecer la validación en un GridItem.
createParagraphTextValidation()ParagraphTextValidationBuilderMuestra una instancia de ParagraphTextValidationBuilder que se puede usar para establecer la validación ParagraphTextItem
createTextValidation()TextValidationBuilderMuestra una instancia de TextValidationBuilder que se puede usar para establecer la validación en un TextItem.
getActiveForm()FormMuestra el formulario en el que la secuencia de comandos está vinculada al contenedor.
getUi()UiDevuelve una instancia del entorno de interfaz de usuario del editor de formularios que permite que la secuencia de comandos agregar funciones como menús, diálogos y barras laterales.
openById(id)FormMuestra el Form con el ID especificado.
openByUrl(url)FormMuestra el objeto Form con la URL especificada.

Documentación detallada

create(title)

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

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

Parámetros

NombreTipoDescripción
titleStringel nombre del formulario nuevo

Volver

Form: El nuevo formulario

Arroja

Error: Si el título especificado 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 alcances:

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

createCheckboxGridValidation()

Devuelve una instancia de CheckboxGridValidationBuilder que puede usarse para establecer la validación en un CheckboxGridItem

Volver

CheckboxGridValidationBuilder


createCheckboxValidation()

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

Volver

CheckboxValidationBuilder


createFeedback()

Devuelve una instancia de QuizFeedbackBuilder que se puede usar para establecer comentarios sobre una calificación Item

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 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 en el que la secuencia de comandos está vinculada al contenedor. Para interactuar con los formularios a los que La secuencia de comandos no está vinculada al contenedor, usa openById(id) o openByUrl(url) en su lugar.

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

Volver

Form: Es el formato 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 alcances:

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

getUi()

Devuelve una instancia del entorno de interfaz de usuario del editor de formularios que permite que la secuencia de comandos agregar funciones como menús, diálogos y barras laterales. Una secuencia de comandos solo puede interactuar con la IU de la la instancia actual de un editor de formulario abierto (no la vista que ve un encuestado) y solo si de comandos está vinculada al formulario. Para ver más 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: Es una instancia del entorno de interfaz de usuario de este formulario.


openById(id)

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

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

Parámetros

NombreTipoDescripción
idStringel ID del formulario que se abrirá

Volver

Form: Es el formulario con el ID proporcionado.

Arroja

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

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

openByUrl(url)

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

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

Parámetros

NombreTipoDescripción
urlStringla URL del formulario que se abrirá

Volver

Form: Es el formulario con la URL dada.

Arroja

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

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