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

PropiedadTipoDescripción
AlignmentAlignmentEs una enumeración de los tipos de alineación de imágenes.
DestinationTypeDestinationTypeEs una enumeración de los tipos de destinos que pueden almacenar respuestas de formularios.
FeedbackTypeFeedbackTypeEs una enumeración de tipos de formulario Feedbacks.
ItemTypeItemTypeEs una enumeración de tipos de formulario Items.
PageNavigationTypePageNavigationTypeEs una 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()CheckboxGridValidationBuilderMuestra una instancia de un CheckboxGridValidationBuilder que se puede usar para establecer la validación en un CheckboxGridItem.
createCheckboxValidation()CheckboxValidationBuilderMuestra una instancia de un CheckboxValidationBuilder que se puede usar para establecer la validación en un CheckboxItem.
createFeedback()QuizFeedbackBuilderMuestra una instancia de un QuizFeedbackBuilder que se puede usar para establecer comentarios en un Item que se puede calificar.
createGridValidation()GridValidationBuilderMuestra una instancia de un GridValidationBuilder que se puede usar para establecer la validación en un GridItem.
createParagraphTextValidation()ParagraphTextValidationBuilderMuestra una instancia de un 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 al que la secuencia de comandos está vinculada al contenedor.
getUi()UiMuestra 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)FormMuestra el Form con el ID especificado.
openByUrl(url)FormMuestra el Form con la URL especificada.

Documentación detallada

create(title)

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

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

Parámetros

NombreTipoDescripción
titleStringel nombre del nuevo formulario

Volver

Form: Es el formulario nuevo.

Arroja

Error: Si el título determinado 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 ámbitos:

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

createCheckboxGridValidation()

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

Volver

CheckboxGridValidationBuilder


createCheckboxValidation()

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

Volver

CheckboxValidationBuilder


createFeedback()

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

Volver

QuizFeedbackBuilder


createGridValidation()

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

Volver

GridValidationBuilder


createParagraphTextValidation()

Muestra una instancia de un 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 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.
const form = FormApp.getActiveForm();

Volver

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

  • 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: Es una instancia del entorno de la interfaz de usuario de este formulario.


openById(id)

Muestra el Form con el ID especificado. Genera 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

NombreTipoDescripción
idStringel ID del formulario que se abrirá

Volver

Form: Es el formulario con el ID determinado.

Arroja

Error: Si el ID proporcionado no es válido o 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 ámbitos:

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

openByUrl(url)

Muestra el Form con la URL especificada. Lanza 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

NombreTipoDescripción
urlStringla URL del formulario que se abrirá

Volver

Form: Es el formulario con la URL determinada.

Arroja

Error: Si la URL proporcionada no es válida o 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 ámbitos:

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