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
Propriedade | Tipo | Descrição |
---|---|---|
Alignment | Alignment | Uma enumeração dos tipos de alinhamento de imagens. |
DestinationType | DestinationType | Uma enumeração dos tipos de destinos que podem armazenar respostas de formulário. |
FeedbackType | FeedbackType | Uma enumeração dos tipos de formulário Feedbacks . |
ItemType | ItemType | Uma enumeração dos tipos de formulário Items . |
PageNavigationType | PageNavigationType | Uma enumeração dos possíveis comportamentos para a navegação em páginas. |
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
create(title) | Form | Cria e retorna um novo Form . |
createCheckboxGridValidation() | CheckboxGridValidationBuilder | Retorna uma instância de um CheckboxGridValidationBuilder que pode ser usada para definir uma validação em um CheckboxGridItem |
createCheckboxValidation() | CheckboxValidationBuilder | Retorna uma instância de um CheckboxValidationBuilder que pode ser usada para definir a validação em um CheckboxItem . |
createFeedback() | QuizFeedbackBuilder | Retorna uma instância de um QuizFeedbackBuilder, que pode ser usado para definir feedback sobre um Item com avaliação. |
createGridValidation() | GridValidationBuilder | Retorna uma instância de um GridValidationBuilder que pode ser usada para definir a validação em um GridItem . |
createParagraphTextValidation() | ParagraphTextValidationBuilder | Retorna uma instância de um ParagraphTextValidationBuilder, que pode ser usada para definir a validação em um ParagraphTextItem . |
createTextValidation() | TextValidationBuilder | Retorna uma instância de um TextValidationBuilder que pode ser usada para definir a validação de um TextItem . |
getActiveForm() | Form | Retorna o formulário em que o script é vinculado pelo contêiner. |
getUi() | Ui | 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. |
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
. 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
Nome | Tipo | Descrição |
---|---|---|
title | String | o 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
createCheckboxValidation()
Retorna uma instância de um CheckboxValidationBuilder que pode ser usada para definir a validação em um CheckboxItem
.
Retornar
createFeedback()
Retorna uma instância de um QuizFeedbackBuilder, que pode ser usado para definir feedback sobre um Item
com avaliação.
Retornar
createGridValidation()
Retorna uma instância de um GridValidationBuilder que pode ser usada para definir a validação em um GridItem
.
Retornar
createParagraphTextValidation()
Retorna uma instância de um ParagraphTextValidationBuilder, que pode ser usada para definir a validação em um ParagraphTextItem
.
Retornar
createTextValidation()
Retorna uma instância de um TextValidationBuilder que pode ser usada para definir a validação de um TextItem
.
Retornar
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
Nome | Tipo | Descrição |
---|---|---|
id | String | o 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
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 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