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 imágenes.
DestinationTypeDestinationTypeUna enumeración de los tipos de destinos que pueden almacenar respuestas de formularios.
FeedbackTypeFeedbackTypeUna enumeración de los tipos de formato Feedbacks.
ItemTypeItemTypeUna enumeración de los tipos de formato Items.
PageNavigationTypePageNavigationTypeEs una enumeración de los posibles comportamientos para navegar por páginas.

Métodos

MétodoTipo de datos que se muestraDescripción breve
create(title)FormCrea y muestra un Form nuevo.
createCheckboxGridValidation()CheckboxGridValidationBuilderMuestra una instancia de CheckboxGridValidationBuilder que se puede usar para establecer la validación en un CheckboxGridItem.
createCheckboxValidation()CheckboxValidationBuilderMuestra una instancia de CheckboxValidationBuilder que se puede usar para configurar la validación en CheckboxItem.
createFeedback()QuizFeedbackBuilderMuestra una instancia de un QuizFeedbackBuilder que se puede usar para establecer comentarios en un Item calificable.
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 en un 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()UiMuestra una instancia del entorno de 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)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 dado está null o está vacío.

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

Parámetros

NombreTipoDescripción
titleStringel nombre del formulario nuevo

Devolvedor

Form: Es el nuevo formulario.

Arroja

Error: si el título dado 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()

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

Devolvedor

CheckboxGridValidationBuilder


createCheckboxValidation()

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

Devolvedor

CheckboxValidationBuilder


createFeedback()

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

Devolvedor

QuizFeedbackBuilder


createGridValidation()

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

Devolvedor

GridValidationBuilder


createParagraphTextValidation()

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

Devolvedor

ParagraphTextValidationBuilder


createTextValidation()

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

Devolvedor

TextValidationBuilder


getActiveForm()

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

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

Devolvedor

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

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

getUi()

Muestra una instancia del entorno de 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 formulario abierto (no la vista que ve el 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 de 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();
}

Devolvedor

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 si 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 para abrir

Devolvedor

Form: Es el formulario con el ID determinado.

Arroja

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

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 si 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 para abrir

Devolvedor

Form: Es el formulario con la URL determinada.

Arroja

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

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