Class FormApp

FormApp

Permite que um script abra uma Form existente ou crie uma nova.

// 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 de tipos de alinhamento de imagem.
DestinationTypeDestinationTypeUma enumeração de tipos de destinos que podem armazenar respostas de formulário.
FeedbackTypeFeedbackTypeUma enumeração de tipos de formulário Feedbacks.
ItemTypeItemTypeUma enumeração de tipos de formulário Items.
PageNavigationTypePageNavigationTypeUma enumeração dos possíveis comportamentos de navegação nas 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 a validação em um CheckboxGridItem.
createCheckboxValidation()CheckboxValidationBuilderRetorna uma instância de um CheckboxValidationBuilder que pode ser usado para definir a validação em um CheckboxItem.
createFeedback()QuizFeedbackBuilderRetorna uma instância de um QuizFeedbackBuilder que pode ser usado para definir o feedback sobre um Item avaliado.
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 usado para definir a validação em um ParagraphTextItem.
createTextValidation()TextValidationBuilderRetorna uma instância de um TextValidationBuilder que pode ser usado para definir a validação em um TextItem.
getActiveForm()FormRetorna o formulário ao qual o script é vinculado ao contêiner.
getUi()UiRetorna uma instância do ambiente de interface do usuário do editor de formulários que permite ao script adicionar recursos como menus, caixas de diálogo e barras laterais.
openById(id)FormRetorna 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. Gera 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

Retorno

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 a validação em um CheckboxGridItem.

Retorno

CheckboxGridValidationBuilder


createCheckboxValidation()

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

Retorno

CheckboxValidationBuilder


createFeedback()

Retorna uma instância de um QuizFeedbackBuilder que pode ser usado para definir o feedback sobre um Item avaliado.

Retorno

QuizFeedbackBuilder


createGridValidation()

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

Retorno

GridValidationBuilder


createParagraphTextValidation()

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

Retorno

ParagraphTextValidationBuilder


createTextValidation()

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

Retorno

TextValidationBuilder


getActiveForm()

Retorna o formulário ao qual o script é vinculado ao contêiner. Para interagir com formulários aos quais o script não está vinculado ao contêiner, use openById(id) ou openByUrl(url).

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

Retorno

Form: o formulário a que 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 de formulários que permite ao script adicionar recursos como menus, caixas de diálogo e barras laterais. Um script só interage com a IU da instância atual de um editor de formulário aberto (não da visualização mostrada ao participante) e somente se o script está vinculado ao formulário. Para mais informações, consulte os guias sobre 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();
}

Retorno

Ui: uma instância do ambiente da interface do usuário do formulário.


openById(id)

Retorna Form com o ID especificado. Lança uma exceção se o ID for inválido ou 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 ID do formulário a ser aberto

Retorno

Form: o formulário com o ID fornecido

Gera

Error: se o ID 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

openByUrl(url)

Retorna o Form com o URL especificado. Lança uma exceção se o URL for inválido ou 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 que será aberto

Retorno

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