Class Form

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

Um formulário que contém itens e propriedades em geral. As propriedades incluem o título, as configurações e o local em que as respostas são armazenadas. Os itens incluem perguntas, como caixas de seleção ou de rádio, enquanto os itens de layout se referem a elementos como quebras de página. Os formulários podem ser acessados ou criados a partir de FormApp.

// Open a form by ID and create a new spreadsheet.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var ss = SpreadsheetApp.create('Spreadsheet Name');

// Update form properties via chaining.
form.setTitle('Form Name')
    .setDescription('Description of form')
    .setConfirmationMessage('Thanks for responding!')
    .setAllowResponseEdits(true)
    .setAcceptingResponses(false);

// Update the form's response destination.
form.setDestination(FormApp.DestinationType.SPREADSHEET, ss.getId());

Métodos

MétodoTipo de retornoBreve descrição
addCheckboxGridItem()CheckboxGridItemAnexa um novo item de pergunta, apresentado como uma grade de colunas e linhas, que permite ao cliente selecionar várias opções por linha em uma sequência de caixas de seleção.
addCheckboxItem()CheckboxItemAnexa um novo item de pergunta que permite ao participante marcar uma ou mais caixas de seleção, bem como um campo opcional "outro".
addDateItem()DateItemAnexa um novo item de pergunta que permite que o participante indique uma data.
addDateTimeItem()DateTimeItemAnexa um novo item de pergunta em que o participante pode indicar a data e a hora.
addDurationItem()DurationItemAnexa um novo item de pergunta que permite que o participante indique um período.
addEditor(emailAddress)FormAdiciona o usuário especificado à lista de editores do Form.
addEditor(user)FormAdiciona o usuário especificado à lista de editores do Form.
addEditors(emailAddresses)FormAdiciona a matriz de usuários especificada à lista de editores do Form.
addGridItem()GridItemAnexa um novo item de pergunta, apresentado como uma grade de colunas e linhas, que permite ao cliente selecionar uma opção por linha em uma sequência de botões de opção.
addImageItem()ImageItemAnexa um novo item de layout que exibe uma imagem.
addListItem()ListItemAnexa um novo item de pergunta que permite ao participante selecionar uma opção em uma lista suspensa.
addMultipleChoiceItem()MultipleChoiceItemAdiciona um novo item de pergunta que permite ao participante selecionar uma opção em uma lista de botões de opção ou em um campo opcional "other".
addPageBreakItem()PageBreakItemAdiciona um novo item de layout que marca o início de uma página.
addParagraphTextItem()ParagraphTextItemAdiciona um novo item de pergunta que permite ao participante inserir um bloco de texto.
addScaleItem()ScaleItemAnexa um novo item de pergunta que permite que o participante escolha uma opção em uma sequência numerada de botões de opção.
addSectionHeaderItem()SectionHeaderItemAnexa um novo item de layout que indica visualmente o início de uma seção.
addTextItem()TextItemAnexa um novo item de pergunta que permite que o participante insira uma única linha de texto.
addTimeItem()TimeItemAnexa um novo item de pergunta que permite que o participante indique um horário do dia.
addVideoItem()VideoItemAnexa um novo item de layout que exibe um vídeo.
canEditResponse()BooleanDetermina se o formulário exibe um link para editar uma resposta após o envio.
collectsEmail()BooleanDetermina se o formulário coleta os endereços de e-mail dos participantes.
createResponse()FormResponseCria uma nova resposta para o formulário.
deleteAllResponses()FormExclui todas as respostas enviadas do armazenamento de respostas do formulário.
deleteItem(index)voidExclui o item de um determinado índice entre todos os itens do formulário.
deleteItem(item)voidExclui o item em questão.
deleteResponse(responseId)FormExclui uma única resposta do armazenamento de respostas do formulário.
getConfirmationMessage()StringRecebe a mensagem de confirmação do formulário.
getCustomClosedFormMessage()StringRecebe a mensagem personalizada que será exibida se o formulário não estiver aceitando respostas ou uma string vazia se nenhuma mensagem personalizada tiver sido definida.
getDescription()StringRecebe a descrição do formulário.
getDestinationId()StringRecebe o ID do destino da resposta do formulário.
getDestinationType()DestinationTypeRecebe o tipo do destino da resposta do formulário.
getEditUrl()StringRecebe o URL que pode ser usado para acessar o modo de edição do formulário.
getEditors()User[]Recebe a lista de editores para esse Form.
getId()StringRecebe o ID do formulário.
getItemById(id)ItemRecebe o item com o ID fornecido.
getItems()Item[]Recebe uma matriz de todos os itens no formulário.
getItems(itemType)Item[]Recebe uma matriz de todos os itens de um determinado tipo.
getPublishedUrl()StringRecebe o URL que pode ser usado para responder ao formulário.
getResponse(responseId)FormResponseRecebe uma única resposta do formulário com base no ID de resposta.
getResponses()FormResponse[]Recebe uma matriz de todas as respostas do formulário.
getResponses(timestamp)FormResponse[]Recebe uma matriz de todas as respostas do formulário após uma determinada data e hora.
getShuffleQuestions()BooleanDetermina se a ordem das perguntas em cada página do formulário é aleatória.
getSummaryUrl()StringRecebe o URL que pode ser usado para visualizar um resumo das respostas do formulário.
getTitle()StringAcessa o título do formulário.
hasLimitOneResponsePerUser()BooleanDetermina se o formulário permite apenas uma resposta por participante.
hasProgressBar()BooleanDetermina se o formulário exibe uma barra de progresso.
hasRespondAgainLink()BooleanDetermina se o formulário mostra um link para enviar outra resposta após o preenchimento.
isAcceptingResponses()BooleanDetermina se o formulário está aceitando respostas.
isPublishingSummary()BooleanDetermina se o formulário exibe um link para visualizar um resumo das respostas após o preenchimento.
isQuiz()BooleanDetermina se o formulário é um teste.
moveItem(from, to)ItemMove um item em um índice específico entre todos os itens do formulário para outro.
moveItem(item, toIndex)ItemMove um determinado item para um determinado índice entre todos os itens do formulário.
removeDestination()FormDesvincula o formulário do destino de resposta atual.
removeEditor(emailAddress)FormRemove o usuário em questão da lista de editores do Form.
removeEditor(user)FormRemove o usuário em questão da lista de editores do Form.
requiresLogin()BooleanDetermina se o formulário exige que os participantes façam login em uma conta no mesmo domínio ou subdomínio para responder.
setAcceptingResponses(enabled)FormDefine se o formulário está aceitando respostas.
setAllowResponseEdits(enabled)FormDefine se o formulário exibe um link para editar uma resposta após o envio.
setCollectEmail(collect)FormDefine se o formulário vai coletar os endereços de e-mail dos participantes.
setConfirmationMessage(message)FormDefine a mensagem de confirmação do formulário.
setCustomClosedFormMessage(message)FormDefine a mensagem a ser exibida se o formulário não estiver aceitando respostas.
setDescription(description)FormDefine a descrição do formulário.
setDestination(type, id)FormDefine o destino onde as respostas do formulário são salvas.
setIsQuiz(enabled)FormDefine se o formulário é um teste.
setLimitOneResponsePerUser(enabled)FormDefine se o formulário permite apenas uma resposta por participante.
setProgressBar(enabled)FormDefine se o formulário tem uma barra de progresso.
setPublishingSummary(enabled)FormDefine se o formulário exibe um link para visualizar um resumo das respostas após o envio do formulário.
setRequireLogin(requireLogin)FormDefine se o formulário exige que os participantes façam login em uma conta no mesmo domínio ou em um subdomínio antes de responder.
setShowLinkToRespondAgain(enabled)FormDefine se o formulário mostra um link para enviar outra resposta após um participante preencher o formulário.
setShuffleQuestions(shuffle)FormDefine se a ordem das perguntas em cada página do formulário é aleatória.
setTitle(title)FormDefine o título do formulário.
shortenFormUrl(url)StringConverte um URL longo de um formulário em um URL curto.
submitGrades(responses)FormEnvia notas para o FormResponses especificado.

Documentação detalhada

addCheckboxGridItem()

Anexa um novo item de pergunta, apresentado como uma grade de colunas e linhas, que permite ao cliente selecionar várias opções por linha em uma sequência de caixas de seleção.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds a checkbox grid item.
const item = form.addCheckboxGridItem();

// Sets the title 'Where did you celebrate New Year's?'
item.setTitle('Where did you celebrate New Year's?');

// Sets the grid's rows and columns.
item.setRows(['New York', 'San Francisco', 'London'])
  .setColumns(['2014', '2015', '2016', '2017']);

Retornar

CheckboxGridItem: o item recém-criado.

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

addCheckboxItem()

Anexa um novo item de pergunta que permite ao participante marcar uma ou mais caixas de seleção, bem como um campo opcional "outro".

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds a checkbox item.
const item = form.addCheckboxItem();

// Sets the title of the checkbox item to 'Do you prefer cats or dogs?'
item.setTitle('Do you prefer cats or dogs?');

// Sets the choices.
item.setChoiceValues(['Cats', 'Dogs']);

Retornar

CheckboxItem: o item recém-criado.

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

addDateItem()

Anexa um novo item de pergunta que permite que o participante indique uma data.

Retornar

DateItem: o item recém-criado.

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

addDateTimeItem()

Anexa um novo item de pergunta em que o participante pode indicar a data e a hora.

Retornar

DateTimeItem: o item recém-criado.

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

addDurationItem()

Anexa um novo item de pergunta que permite que o participante indique um período.

Retornar

DurationItem: o item recém-criado.

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

addEditor(emailAddress)

Adiciona o usuário especificado à lista de editores do Form. Se o usuário já estiver na lista de espectadores, esse método o promoverá fora da lista.

Parâmetros

NameTipoDescrição
emailAddressStringEndereço de e-mail do usuário a ser adicionado.

Retornar

Form: este Form, para encadeamento.

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

addEditor(user)

Adiciona o usuário especificado à lista de editores do Form. Se o usuário já estiver na lista de espectadores, esse método o promoverá fora da lista.

Parâmetros

NameTipoDescrição
userUserUma representação do usuário a ser adicionado.

Retornar

Form: este Form, para encadeamento.

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

addEditors(emailAddresses)

Adiciona a matriz de usuários especificada à lista de editores do Form. Se algum dos usuários já estiver na lista de visualizadores, esse método os promoverá fora da lista de visualizadores.

Parâmetros

NameTipoDescrição
emailAddressesString[]Uma matriz de endereços de e-mail dos usuários a serem adicionados.

Retornar

Form: este Form, para encadeamento.

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

addGridItem()

Anexa um novo item de pergunta, apresentado como uma grade de colunas e linhas, que permite ao cliente selecionar uma opção por linha em uma sequência de botões de opção.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds a multiple choice grid.
const item = form.addGridItem();

// Sets the title to 'Rate your interests.'
item.setTitle('Rate your interests');

// Sets the grid's rows and columns.
item.setRows(['Cars', 'Computers', 'Celebrities'])
  .setColumns(['Boring', 'So-so', 'Interesting']);

Retornar

GridItem: o item recém-criado.

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

addImageItem()

Anexa um novo item de layout que exibe uma imagem.

Retornar

ImageItem: o item recém-criado.

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

addListItem()

Anexa um novo item de pergunta que permite ao participante selecionar uma opção em uma lista suspensa.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds a dropdown list to the form.
const item = form.addListItem();

// Sets the title to 'Do you prefer cats or dogs?'
item.setTitle('Do you prefer cats or dogs?');

// Sets the description to 'This is description text...'
item.setHelpText('This is description text...');

// Creates and adds choices to the dropdown list.
item.setChoices([
  item.createChoice('dog'),
  item.createChoice('cat')
]);

Retornar

ListItem: o item recém-criado.

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

addMultipleChoiceItem()

Adiciona um novo item de pergunta que permite ao participante selecionar uma opção em uma lista de botões de opção ou em um campo opcional "other".

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds a multiple choice item to the form.
const item = form.addMultipleChoiceItem();

// Sets the title.
item.setTitle('What is your favorite ice cream flavor?');

// Creates some choice items.
const vanilla = item.createChoice('vanilla');
const chocolate = item.createChoice('chocolate');
const strawberry = item.createChoice('strawberry');

// Sets the choices.
item.setChoices([vanilla, chocolate, strawberry]);

Retornar

MultipleChoiceItem: o item recém-criado.

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

addPageBreakItem()

Adiciona um novo item de layout que marca o início de uma página.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds page break items to create a second and third page for the form.
const pageTwo = form.addPageBreakItem();
const pageThree = form.addPageBreakItem();

// Sets the titles for the pages.
pageTwo.setTitle('Page two');
pageThree.setTitle('Page three');

// Upon completion of the first page, sets the form to navigate to the third page.
pageTwo.setGoToPage(pageThree);

// Upon completion of the second page, sets the form to navigate back to the first page.
pageThree.setGoToPage(FormApp.PageNavigationType.RESTART);

Retornar

PageBreakItem: o item recém-criado.

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

addParagraphTextItem()

Adiciona um novo item de pergunta que permite ao participante inserir um bloco de texto.

// Opens the form by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds the paragraph text item.
const item = form.addParagraphTextItem();

// Sets the title to 'What is your address?'
item.setTitle('What is your address?');

Retornar

ParagraphTextItem: o item recém-criado.

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

addScaleItem()

Anexa um novo item de pergunta que permite que o participante escolha uma opção em uma sequência numerada de botões de opção.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds the scale item.
const item = form.addScaleItem();

// Sets the title of the scale item to 'Choose a number.'
item.setTitle('Choose a number');

// Sets the scale to 1-5.
item.setBounds(1, 5);

// Sets the label for the lower and upper bounds.
item.setLabels('Lowest', 'Highest');

Retornar

ScaleItem: o item recém-criado.

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

addSectionHeaderItem()

Anexa um novo item de layout que indica visualmente o início de uma seção.

 // Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds the section heading item.
const item = form.addSectionHeaderItem();

// Sets the title to 'Title of new section.'
item.setTitle('Title of new section');

// Sets the description.
item.setHelpText('Description of new section');

Retornar

SectionHeaderItem: o item recém-criado.

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

addTextItem()

Anexa um novo item de pergunta que permite que o participante insira uma única linha de texto.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Adds a single-line text item.
const item = form.addTextItem();

// Sets the title to 'What is your name?'
item.setTitle('What is your name?');

Retornar

TextItem: o item recém-criado.

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

addTimeItem()

Anexa um novo item de pergunta que permite que o participante indique um horário do dia.

Retornar

TimeItem: o item recém-criado.

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

addVideoItem()

Anexa um novo item de layout que exibe um vídeo.

Retornar

VideoItem: o item recém-criado.

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

canEditResponse()

Determina se o formulário exibe um link para editar uma resposta após o envio.

Independentemente dessa configuração, o método FormResponse.getEditResponseUrl() permite que um autor do script com acesso de edição ao formulário gere um URL que pode ser usado para editar uma resposta.

Retornar

Booleantrue se o formulário exibir um link "Editar sua resposta"; false se não

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

collectsEmail()

Determina se o formulário coleta os endereços de e-mail dos participantes.

Retornar

Boolean: true se o formulário coletar endereços de e-mail; false se não for

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

createResponse()

Cria uma nova resposta para o formulário. Para responder a um item de pergunta, crie um ItemResponse com base nele e anexe-o a essa resposta do formulário chamando FormResponse.withItemResponse(response). Para salvar a resposta criada, chame FormResponse.submit().

Retornar

FormResponse: a resposta do formulário recém-criada.

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

deleteAllResponses()

Exclui todas as respostas enviadas do armazenamento de respostas do formulário. Esse método não exclui cópias de respostas armazenadas em um destino de resposta externo, como uma planilha, mas limpa a visualização de resumo do formulário.

Retornar

Form: este Form para encadeamentos

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

deleteItem(index)

Exclui o item de um determinado índice entre todos os itens do formulário. Uma exceção de script será gerada se nenhum item existir no índice especificado.

Parâmetros

NameTipoDescrição
indexIntegero índice do item entre todos os itens do formulário

Gera

Error: caso não haja nenhum item no índice especificado

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

deleteItem(item)

Exclui o item em questão. Uma exceção de script será gerada se o item já tiver sido excluído.

Parâmetros

NameTipoDescrição
itemItemo item a ser excluído

Gera

Error: caso o item não exista no 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

deleteResponse(responseId)

Exclui uma única resposta do armazenamento de respostas do formulário. Esse método não exclui cópias de respostas armazenadas em um destino de resposta externo (como uma planilha), mas remove a resposta da visualização de resumo do formulário. O ID da resposta pode ser recuperado com FormResponse.getId().

Parâmetros

NameTipoDescrição
responseIdStringo ID da resposta do formulário a ser excluída

Retornar

Form: este Form para encadeamentos

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

getConfirmationMessage()

Recebe a mensagem de confirmação do formulário.

Retornar

String: a mensagem de confirmação do 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

getCustomClosedFormMessage()

Recebe a mensagem personalizada que será exibida se o formulário não estiver aceitando respostas ou uma string vazia se nenhuma mensagem personalizada tiver sido definida.

Retornar

String: a mensagem personalizada que será exibida se o formulário não estiver aceitando respostas, ou uma string vazia se nenhuma mensagem personalizada tiver sido definida.

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

getDescription()

Recebe a descrição do formulário.

Retornar

String: a descrição do 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

getDestinationId()

Recebe o ID do destino da resposta do formulário.

Retornar

String: o ID do destino da resposta do 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

getDestinationType()

Recebe o tipo do destino da resposta do formulário.

Retornar

DestinationType: o tipo de destino da resposta do 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

getEditUrl()

Recebe o URL que pode ser usado para acessar o modo de edição do formulário.

Retornar

String: o URL para editar o 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

getEditors()

Recebe a lista de editores para esse Form.

Retornar

User[]: uma matriz de usuários com permissão para edição.

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

getId()

Recebe o ID do formulário.

Retornar

String: o ID do 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

getItemById(id)

Recebe o item com o ID fornecido. Retornará null se o ID não corresponder a um item no formulário.

Parâmetros

NameTipoDescrição
idIntegero código do item

Retornar

Item: o item com o código fornecido, ou null se o item não existir no 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

getItems()

Recebe uma matriz de todos os itens no formulário.

Retornar

Item[]: uma matriz de todos os itens no 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

getItems(itemType)

Recebe uma matriz de todos os itens de um determinado tipo.

Parâmetros

NameTipoDescrição
itemTypeItemTypeo tipo de itens a serem recuperados.

Retornar

Item[]: uma matriz de todos os itens desse tipo.

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

getPublishedUrl()

Recebe o URL que pode ser usado para responder ao formulário.

Retornar

String: o URL para responder ao 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

getResponse(responseId)

Recebe uma única resposta do formulário com base no ID de resposta. Os IDs de resposta podem ser recuperados em FormResponse.getId().

Parâmetros

NameTipoDescrição
responseIdStringo ID da resposta do formulário

Retornar

FormResponse: a resposta do formulário

Gera

Error: caso a resposta não exista.

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

getResponses()

Recebe uma matriz de todas as respostas do formulário.

Retornar

FormResponse[]: uma matriz de todas as respostas do 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

getResponses(timestamp)

Recebe uma matriz de todas as respostas do formulário após uma determinada data e hora.

Parâmetros

NameTipoDescrição
timestampDatea data e a hora mais antigas para as quais as respostas do formulário devem ser retornadas.

Retornar

FormResponse[]: a lista de respostas do 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

getShuffleQuestions()

Determina se a ordem das perguntas em cada página do formulário é aleatória.

Retornar

Boolean: true se a ordem das perguntas em cada página do formulário for aleatória; false se não for

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

getSummaryUrl()

Recebe o URL que pode ser usado para visualizar um resumo das respostas do formulário. A menos que setPublishingSummary(enabled) esteja definido como true, somente os usuários com permissão para edição no formulário poderão acessar o URL.

Retornar

String: o URL para ver um resumo das respostas

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

getTitle()

Acessa o título do formulário.

Retornar

String: o título do 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

hasLimitOneResponsePerUser()

Determina se o formulário permite apenas uma resposta por participante. Se o valor for true, o script não vai poder enviar respostas ao formulário.

Retornar

Booleantrue se o formulário permitir apenas uma resposta por participante; false se não permitir

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

hasProgressBar()

Determina se o formulário exibe uma barra de progresso.

Retornar

Boolean: true se o formulário exibir uma barra de progresso; false se não for

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

Determina se o formulário mostra um link para enviar outra resposta após o preenchimento.

Retornar

Boolean: true se o formulário exibir um link "Enviar outra resposta"; false se não for

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

isAcceptingResponses()

Determina se o formulário está aceitando respostas.

Retornar

Booleantrue se o formulário estiver aceitando respostas; false se não estiver

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

isPublishingSummary()

Determina se o formulário exibe um link para visualizar um resumo das respostas após o preenchimento.

Retornar

Boolean: true se o formulário exibir um link "Ver respostas anteriores"; false se não for

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

isQuiz()

Determina se o formulário é um teste.

Retornar

Booleantrue se o formulário estiver aceitando respostas; false se não estiver

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

moveItem(from, to)

Move um item em um índice específico entre todos os itens do formulário para outro. Emite uma exceção de script se o índice to estiver fora dos limites.

Parâmetros

NameTipoDescrição
fromIntegero índice atual do item entre todos os itens no formulário
toIntegero novo índice do item entre todos os itens do formulário

Retornar

Item: o item que foi movido

Gera

Error: se um dos índices estiver fora dos limites.

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

moveItem(item, toIndex)

Move um determinado item para um determinado índice entre todos os itens do formulário. Uma exceção de script será gerada se o índice especificado estiver fora dos limites.

Parâmetros

NameTipoDescrição
itemItemo item a ser movido
toIndexIntegero novo índice do item entre todos os itens do formulário

Retornar

Item: o item que foi movido

Gera

Error: se o índice estiver fora dos limites

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

removeDestination()

Desvincula o formulário do destino de resposta atual. O destino antigo desvinculado ainda mantém uma cópia de todas as respostas anteriores. Todos os formulários, incluindo aqueles que não têm um destino definido explicitamente, salve uma cópia das respostas no armazenamento de respostas do formulário. Se o formulário não tiver um destino de resposta, esse método não terá efeito.

Retornar

Form: este Form para encadeamentos

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

removeEditor(emailAddress)

Remove o usuário em questão da lista de editores do Form. Esse método não impede que os usuários acessem o Form se pertencerem a uma classe de usuários com acesso geral, por exemplo, se o Form for compartilhado com todo o domínio do usuário ou se Form estiver em um drive compartilhado que o usuário possa acessar.

No caso de arquivos do Drive, isso também remove o usuário da lista de leitores.

Parâmetros

NameTipoDescrição
emailAddressStringEndereço de e-mail do usuário a ser removido.

Retornar

Form: este Form, para encadeamento.

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

removeEditor(user)

Remove o usuário em questão da lista de editores do Form. Esse método não impede que os usuários acessem o Form se pertencerem a uma classe de usuários com acesso geral, por exemplo, se o Form for compartilhado com todo o domínio do usuário ou se Form estiver em um drive compartilhado que o usuário possa acessar.

No caso de arquivos do Drive, isso também remove o usuário da lista de leitores.

Parâmetros

NameTipoDescrição
userUserUma representação do usuário a ser removido.

Retornar

Form: este Form, para encadeamento.

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

requiresLogin()

Determina se o formulário exige que os participantes façam login em uma conta no mesmo domínio ou subdomínio para responder.

Retornar

Boolean: true se o formulário exigir que os usuários façam login. false em caso negativo


setAcceptingResponses(enabled)

Define se o formulário está aceitando respostas. O padrão para novos formulários é true.

Parâmetros

NameTipoDescrição
enabledBooleantrue se o formulário aceitar respostas; false se não for

Retornar

Form: este Form para encadeamentos

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

setAllowResponseEdits(enabled)

Define se o formulário exibe um link para editar uma resposta após o envio. O padrão para novos formulários é false.

Independentemente dessa configuração, o método FormResponse.getEditResponseUrl() permite que um autor do script com permissão de edição ao formulário gere um URL que pode ser usado para editar uma resposta.

Parâmetros

NameTipoDescrição
enabledBooleantrue se o formulário exibir um link "Editar sua resposta"; false se não for

Retornar

Form: este Form para encadeamentos

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

setCollectEmail(collect)

Define se o formulário vai coletar os endereços de e-mail dos participantes. O padrão para novos formulários é false.

Parâmetros

NameTipoDescrição
collectBooleantrue se o formulário coletar endereços de e-mail; false se não for

Retornar

Form: este Form para encadeamentos

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

setConfirmationMessage(message)

Define a mensagem de confirmação do formulário.

Parâmetros

NameTipoDescrição
messageStringa nova mensagem de confirmação do formulário

Retornar

Form: este Form para encadeamentos

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

setCustomClosedFormMessage(message)

Define a mensagem a ser exibida se o formulário não estiver aceitando respostas. Se nenhuma mensagem for definida, o formulário usará uma mensagem padrão.

Parâmetros

NameTipoDescrição
messageStringa mensagem exibida se o formulário não estiver aceitando respostas

Retornar

Form: este Form para encadeamentos

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

setDescription(description)

Define a descrição do formulário.

Parâmetros

NameTipoDescrição
descriptionStringa nova descrição do formulário

Retornar

Form: este Form para encadeamentos

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

setDestination(type, id)

Define o destino onde as respostas do formulário são salvas. Todos os formulários, incluindo aqueles que não têm um destino explicitamente definido, salve uma cópia das respostas no armazenamento de respostas do formulário.

Parâmetros

NameTipoDescrição
typeDestinationTypeo tipo de destino da resposta do formulário
idStringo ID do destino da resposta do formulário

Retornar

Form: este Form para encadeamentos

Gera

Error: se o ID de destino fornecido for inválido.

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

setIsQuiz(enabled)

Define se o formulário é um teste. O padrão para novos formulários é false.

Só é permitido usar perguntas com nota nos Testes. Portanto, definir como "falso" fará com que todas as opções de avaliação sejam removidas de todas as perguntas.

As configurações de teste estão disponíveis apenas na nova IU do Formulários. Ao criar um formulário, um teste passa a usar a nova IU.

Parâmetros

NameTipoDescrição
enabledBooleantrue se os recursos de teste precisarem ser ativados para o formulário. Caso contrário, false

Retornar

Form: este Form para encadeamentos

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

setLimitOneResponsePerUser(enabled)

Define se o formulário permite apenas uma resposta por participante. O padrão para novos formulários é false. Se o valor for definido como true, o script não poderá enviar respostas de formulário.

Parâmetros

NameTipoDescrição
enabledBooleantrue se o formulário permitir apenas uma resposta por participante, false se não

Retornar

Form: este Form para encadeamentos

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

setProgressBar(enabled)

Define se o formulário tem uma barra de progresso. O padrão para novos formulários é false.

Parâmetros

NameTipoDescrição
enabledBooleantrue se o formulário exibir uma barra de progresso; false se não

Retornar

Form: este Form para encadeamentos

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

setPublishingSummary(enabled)

Define se o formulário exibe um link para visualizar um resumo das respostas após o envio do formulário. O padrão para novos formulários é false.

Parâmetros

NameTipoDescrição
enabledBooleantrue se o formulário exibir um link "Ver respostas anteriores"; false se não

Retornar

Form: este Form para encadeamentos

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

setRequireLogin(requireLogin)

Define se o formulário exige que os participantes façam login em uma conta no mesmo domínio ou em um subdomínio antes de responder. O padrão para novos formulários é false, a menos que um administrador do domínio mude o padrão.

Esse recurso só está disponível nos formulários criados pelos usuários do Google Workspace. Não é necessário que os usuários de outros tipos de Contas do Google façam login.

Parâmetros

NameTipoDescrição
requireLoginBooleantrue se o formulário exigir que os usuários façam login. false se não for

Retornar

Form: o formulário atual (para encadeamentos)

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

setShowLinkToRespondAgain(enabled)

Define se o formulário mostra um link para enviar outra resposta após um participante preencher o formulário. O padrão para novos formulários é true.

Parâmetros

NameTipoDescrição
enabledBooleantrue se o formulário exibir um link "Enviar outra resposta"; false se não

Retornar

Form: este Form para encadeamentos

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

setShuffleQuestions(shuffle)

Define se a ordem das perguntas em cada página do formulário é aleatória.

Parâmetros

NameTipoDescrição
shuffleBooleantrue se a ordem das perguntas em cada página do formulário for aleatória. false se não for

Retornar

Form: este Form para encadeamentos

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

setTitle(title)

Define o título do formulário.

Parâmetros

NameTipoDescrição
titleStringnovo título do formulário

Retornar

Form: este Form para encadeamentos

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

shortenFormUrl(url)

Converte um URL longo de um formulário em um URL curto. Gera uma exceção se o URL longo não for pertencer ao Formulários Google.

Parâmetros

NameTipoDescrição
urlString

Retornar

String: um URL no formato http://goo.gl/forms/1234

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

submitGrades(responses)

Envia notas para o FormResponses especificado.

Se o código incluir um gatilho onFormSubmit, chamar submitGrades() acionará a condição onFormSubmit e causará um loop infinito. Para evitar o loop infinito, adicione um código que verifica se as notas já existem antes de chamar submitGrades().

Parâmetros

NameTipoDescrição
responsesFormResponse[]

Retornar

Form: este Form, para encadeamento.

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