Class FormApp

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

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

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

Propriedades

Propriedade	Tipo	Descrição
`Alignment`	`Alignment`	Uma enumeração de tipos de alinhamento de imagem.
`DestinationType`	`DestinationType`	Uma enumeração de tipos de destinos que podem armazenar respostas de formulários.
`FeedbackType`	`FeedbackType`	Uma enumeração de tipos de `Feedbacks` de formulários.
`ItemType`	`ItemType`	Uma enumeração de tipos de `Items` de formulários.
`PageNavigationType`	`PageNavigationType`	Uma enumeração de comportamentos possíveis para navegar pelas páginas.
`RatingIconType`	`RatingIconType`	Uma enumeração de tipos de ícones de classificação `RatingIcons`

Métodos

Método	Tipo de retorno	Breve descrição
`create(title)`	`Form`	Cria e retorna um novo `Form`.
`create(title, isPublished)`	`Form`	Cria e retorna um novo `Form` no estado de publicação solicitado.
`createCheckboxGridValidation()`	`CheckboxGridValidationBuilder`	Retorna uma instância de um CheckboxGridValidationBuilder que pode ser usado para definir a validação em um `CheckboxGridItem`.
`createCheckboxValidation()`	`CheckboxValidationBuilder`	Retorna uma instância de um CheckboxValidationBuilder que pode ser usado para definir a validação em um `CheckboxItem`.
`createFeedback()`	`QuizFeedbackBuilder`	Retorna uma instância de um QuizFeedbackBuilder que pode ser usado para definir o feedback em um `Item` classificável.
`createGridValidation()`	`GridValidationBuilder`	Retorna uma instância de um GridValidationBuilder que pode ser usado para definir a validação em um `GridItem`.
`createParagraphTextValidation()`	`ParagraphTextValidationBuilder`	Retorna uma instância de um ParagraphTextValidationBuilder que pode ser usado para definir a validação em um `ParagraphTextItem`.
`createTextValidation()`	`TextValidationBuilder`	Retorna uma instância de um TextValidationBuilder que pode ser usado para definir a validação em um `TextItem`.
`getActiveForm()`	`Form`	Retorna o formulário ao qual o script está vinculado ao contêiner.
`getUi()`	`Ui`	Retorna uma instância do ambiente de interface do usuário do editor de formulários que permite que o script adicione recursos como menus, caixas de diálogo e barras laterais.
`openById(id)`	`Form`	Retorna o `Form` com o ID especificado.
`openByUrl(url)`	`Form`	Retorna 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.
const form = FormApp.create('Form Name');

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	O nome do novo formulário.

Retornar

Form — a nova postura.

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

`create(title, isPublished)`

Cria e retorna um novo Form no estado de publicação solicitado. Gera uma exceção se o título fornecido for null ou estiver vazio.

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

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	O nome do novo formulário.
`isPublished`	`Boolean`	Indica se o formulário precisa ser publicado.

Retornar

Form — a nova postura.

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

Retornar

CheckboxGridValidationBuilder

`createCheckboxValidation()`

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

Retornar

CheckboxValidationBuilder

`createFeedback()`

Retorna uma instância de um QuizFeedbackBuilder que pode ser usado para definir o feedback em um Item classificável.

Retornar

QuizFeedbackBuilder

`createGridValidation()`

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

Retornar

GridValidationBuilder

`createParagraphTextValidation()`

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

Retornar

ParagraphTextValidationBuilder

`createTextValidation()`

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

Retornar

TextValidationBuilder

`getActiveForm()`

Retorna o formulário ao qual o script está 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.
const 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 de formulários que permite que o script adicione recursos como menus, caixas de diálogo e barras laterais. Um script só pode interagir com a interface do usuário da instância atual de um editor de formulários aberto (não 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 desse formulário

`openById(id)`

Retorna o Form com o ID especificado. Gera 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.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

Parâmetros

Nome	Tipo	Descrição
`id`	`String`	o ID 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. Gera 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.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit',
);

Parâmetros

Nome	Tipo	Descrição
`url`	`String`	o 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 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

Class FormApp Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Propriedades

Métodos

Documentação detalhada

create(title)

Parâmetros

Retornar

Gera

Autorização

create(title, isPublished)

Parâmetros

Retornar

Gera

Autorização

createCheckboxGridValidation()

Retornar

createCheckboxValidation()

Retornar

createFeedback()

Retornar

createGridValidation()

Retornar

createParagraphTextValidation()

Retornar

createTextValidation()

Retornar

getActiveForm()

Retornar

Autorização

getUi()

Retornar

openById(id)

Parâmetros

Retornar

Gera

Autorização

openByUrl(url)

Parâmetros

Retornar

Gera

Autorização

Class FormApp

`create(title)`

`create(title, isPublished)`

`createCheckboxGridValidation()`

`createCheckboxValidation()`

`createFeedback()`

`createGridValidation()`

`createParagraphTextValidation()`

`createTextValidation()`

`getActiveForm()`

`getUi()`

`openById(id)`

`openByUrl(url)`