Class FormApp

FormApp

Permite que um script abra um Form existente ou crie um novo.

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

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

Propriedades

PropriedadeTipoDescrição
AlignmentAlignmentUma enumeração dos tipos de alinhamento de imagens.
DestinationTypeDestinationTypeUma enumeração dos tipos de destinos que podem armazenar respostas de formulário.
FeedbackTypeFeedbackTypeUma enumeração dos tipos de formulário Feedbacks.
ItemTypeItemTypeUma enumeração dos tipos de formulário Items.
PageNavigationTypePageNavigationTypeUma enumeração dos possíveis comportamentos para a navegação em páginas.

Métodos

MétodoTipo de retornoBreve descrição
create(title)FormCria e retorna um novo Form.
createCheckboxGridValidation()CheckboxGridValidationBuilderRetorna uma instância de um CheckboxGridValidationBuilder que pode ser usada para definir uma validação em um CheckboxGridItem
createCheckboxValidation()CheckboxValidationBuilderRetorna uma instância de um CheckboxValidationBuilder que pode ser usada para definir a validação em um CheckboxItem.
createFeedback()QuizFeedbackBuilderRetorna uma instância de um QuizFeedbackBuilder, que pode ser usado para definir feedback sobre um Item com avaliação.
createGridValidation()GridValidationBuilderRetorna uma instância de um GridValidationBuilder que pode ser usada para definir a validação em um GridItem.
createParagraphTextValidation()ParagraphTextValidationBuilderRetorna uma instância de um ParagraphTextValidationBuilder, que pode ser usada para definir a validação em um ParagraphTextItem.
createTextValidation()TextValidationBuilderRetorna uma instância de um TextValidationBuilder que pode ser usada para definir a validação de um TextItem.
getActiveForm()FormRetorna o formulário em que o script é vinculado pelo contêiner.
getUi()UiRetorna uma instância do ambiente de interface do usuário do editor do formulário que permite que o script adicione recursos como menus, caixas de diálogo e barras laterais.
openById(id)FormRetorna o Form com o ID especificado.
openByUrl(url)FormRetorna o Form com o URL especificado.

Documentação detalhada

create(title)

Cria e retorna um novo Form. Emite uma exceção se o título fornecido for null ou estiver vazio.

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

Parâmetros

NomeTipoDescrição
titleStringo nome do novo formulário.

Retornar

Form: o novo formulário.

Gera

Error: se o título fornecido for null ou estiver vazio

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

createCheckboxGridValidation()

Retorna uma instância de um CheckboxGridValidationBuilder que pode ser usada para definir uma validação em um CheckboxGridItem

Retornar

CheckboxGridValidationBuilder


createCheckboxValidation()

Retorna uma instância de um CheckboxValidationBuilder que pode ser usada para definir a validação em um CheckboxItem.

Retornar

CheckboxValidationBuilder


createFeedback()

Retorna uma instância de um QuizFeedbackBuilder, que pode ser usado para definir feedback sobre um Item com avaliação.

Retornar

QuizFeedbackBuilder


createGridValidation()

Retorna uma instância de um GridValidationBuilder que pode ser usada para definir a validação em um GridItem.

Retornar

GridValidationBuilder


createParagraphTextValidation()

Retorna uma instância de um ParagraphTextValidationBuilder, que pode ser usada para definir a validação em um ParagraphTextItem.

Retornar

ParagraphTextValidationBuilder


createTextValidation()

Retorna uma instância de um TextValidationBuilder que pode ser usada para definir a validação de um TextItem.

Retornar

TextValidationBuilder


getActiveForm()

Retorna o formulário em que o script é vinculado pelo contêiner. Para interagir com formulários a que o script não está vinculado por contêiner, use openById(id) ou openByUrl(url).

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

Retornar

Form: o formulário ao qual o script está vinculado, ou null se o script não estiver vinculado a um formulário.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getUi()

Retorna uma instância do ambiente de interface do usuário do editor do formulário que permite que o script adicione recursos como menus, caixas de diálogo e barras laterais. Um script só pode interagir com a IU para a instância atual de um editor de formulários aberto (não para a visualização que um participante vê) e somente se o script estiver vinculado ao formulário. Para mais informações, consulte os guias de menus e caixas de diálogo e barras laterais.

// 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();
}

Retornar

Ui: uma instância do ambiente de interface do usuário deste formulário


openById(id)

Retorna o Form com o ID especificado. Lança uma exceção se o ID for inválido ou se o usuário não tiver permissão para abrir o formulário.

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

Parâmetros

NomeTipoDescrição
idStringo código do formulário a ser aberto

Retornar

Form: o formulário com o ID fornecido.

Gera

Error: se o ID fornecido for inválido ou se o usuário não tiver permissões suficientes

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

openByUrl(url)

Retorna o Form com o URL especificado. Lança uma exceção se o URL for inválido ou se o usuário não tiver permissão para abrir o formulário.

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

Parâmetros

NomeTipoDescrição
urlStringo URL do formulário a ser aberto

Retornar

Form: o formulário com o URL fornecido

Gera

Error: se o URL fornecido for inválido ou o usuário não tiver permissões suficientes

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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