Class Form

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

Um formulário que contém propriedades e itens em geral. As propriedades incluem título, configurações e onde as respostas são armazenadas. Os itens incluem perguntas, como caixas de seleção ou opções de rádio, enquanto os itens de layout são referentes a itens como quebras de página. É possível acessar ou criar formulários no 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, permitindo que o participante selecione várias opções por linha de 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 "quot;other" opcional".
addDateItem()DateItemAnexa um novo item de pergunta que permite que o participante indique uma data.
addDateTimeItem()DateTimeItemAnexa um novo item de pergunta que permite que o participante indique uma data e 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 de Form.
addEditor(user)FormAdiciona o usuário especificado à lista de editores de Form.
addEditors(emailAddresses)FormAdiciona a matriz especificada de usuários à lista de editores de Form.
addGridItem()GridItemanexa um novo item de pergunta, apresentado como uma grade de colunas e linhas, permitindo que o participante selecione 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 que o participante selecione uma opção em uma lista suspensa.
addMultipleChoiceItem()MultipleChoiceItemAnexa um novo item de pergunta que permite que o participante selecione uma opção em uma lista de botões de opção ou um campo opcional "quot;other"".
addPageBreakItem()PageBreakItemAnexa um novo item de layout que marca o início de uma página.
addParagraphTextItem()ParagraphTextItemAnexa um novo item de pergunta que permite que o participante insira 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 repositório de respostas do formulário.
deleteItem(index)voidExclui o item em um determinado índice entre todos os itens no formulário.
deleteItem(item)voidExclui o item especificado.
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 desse Form.
getId()StringRecebe o ID do formulário.
getItemById(id)ItemRecebe o item com um determinado código.
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 da 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 depois de 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()StringRecebe 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 exibe 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 ver um resumo das respostas após o participante preencher o formulário.
isQuiz()BooleanDefine se o formulário é um teste.
moveItem(from, to)ItemMove um item em um determinado índice entre todos os itens do formulário para outro índice.
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 especificado da lista de editores para o Form.
removeEditor(user)FormRemove o usuário especificado da lista de editores para o Form.
requiresLogin()BooleanDetermina 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.
setAcceptingResponses(enabled)FormDefine se o formulário está aceitando respostas no momento.
setAllowResponseEdits(enabled)FormDefine se o formulário exibirá um link para editar uma resposta após o envio.
setCollectEmail(collect)FormDefine se o formulário coleta endereços de e-mail dos participantes.
setConfirmationMessage(message)FormDefine a mensagem de confirmação do formulário.
setCustomClosedFormMessage(message)FormDefine que a mensagem 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 no qual 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 participante.
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 exibe um link para enviar outra resposta após o preenchimento.
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 os FormResponses fornecidos.

Documentação detalhada

addCheckboxGridItem()

anexa um novo item de pergunta, apresentado como uma grade de colunas e linhas, permitindo que o participante selecione várias opções por linha de uma sequência de caixas de seleção.

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 "quot;other" opcional".

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 que permite que o participante indique uma data e 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 de Form. Se o usuário já estiver na lista de visualizadores, esse método vai promovê-lo fora da lista.

Parâmetros

NomeTipoDescrição
emailAddressStringO endereç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 de Form. Se o usuário já estiver na lista de visualizadores, esse método vai promovê-lo fora da lista.

Parâmetros

NomeTipoDescriçã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 especificada de usuários à lista de editores de Form. Se algum dos usuários já estiver na lista de visualizadores, esse método os promoverá fora da lista de espectadores.

Parâmetros

NomeTipoDescriçã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, permitindo que o participante selecione uma opção por linha em uma sequência de botões de opção.

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 que o participante selecione uma opção em uma lista suspensa.

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()

Anexa um novo item de pergunta que permite que o participante selecione uma opção em uma lista de botões de opção ou um campo opcional "quot;other"".

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()

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

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()

Anexa um novo item de pergunta que permite que o participante insira um bloco de texto.

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.

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.

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.

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 para editar o formulário gere um URL que pode ser usado para editar uma resposta.

Retornar

Boolean: true se o formulário exibe um link "Editar sua resposta&;t;; caso contrário, false

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 coleta endereços de e-mail. Caso contrário, será false

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 uma pergunta, crie um ItemResponse a partir do item e anexe-o a esta 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 repositório 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 resumida do formulário.

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

deleteItem(index)

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

Parâmetros

NomeTipoDescrição
indexIntegeríndice do item entre todos os itens no formulário

Gera

Error: se nenhum item existir 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 especificado. Uma exceção de script será gerada se o item já tiver sido excluído.

Parâmetros

NomeTipoDescrição
itemItemo item a ser excluído

Gera

Error: 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

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 resumida do formulário. O ID de resposta pode ser recuperado com FormResponse.getId().

Parâmetros

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

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

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 desse 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 um determinado código. Retornará null se o ID não corresponder a um item no formulário.

Parâmetros

NomeTipoDescrição
idIntegerID 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

NomeTipoDescriçã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 da resposta. Os IDs de resposta podem ser recuperados de FormResponse.getId().

Parâmetros

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

Retornar

FormResponse: a resposta do formulário

Gera

Error: se a resposta não existir

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 dos formulários.

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 depois de uma determinada data e hora.

Parâmetros

NomeTipoDescrição
timestampDatea data e a hora mais antigas em que 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) seja 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()

Recebe 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 poderá enviar respostas do formulário.

Retornar

Boolean: true se o formulário permite apenas uma resposta por participante; se não for, false

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 exibe 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 exibe um link para enviar outra resposta após o preenchimento.

Retornar

Boolean: true se o formulário exibe um link "Submit another response"; 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

isAcceptingResponses()

Determina se o formulário está aceitando respostas.

Retornar

Boolean: true 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 ver um resumo das respostas após o participante preencher o formulário.

Retornar

Booleantrue se o formulário exibir um link "Ver respostas anteriores"; caso contrário, false

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()

Define se o formulário é um teste.

Retornar

Boolean: true 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 determinado índice entre todos os itens do formulário para outro índice. Uma exceção de script é gerada se o índice to estiver fora dos limites.

Parâmetros

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

Retornar

Item: o item que foi movido.

Gera

Error: se algum 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

NomeTipoDescrição
itemItemo item a ser movido;
toIndexIntegero novo índice do item entre todos os itens no 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 anterior 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 de 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 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(emailAddress)

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

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

Parâmetros

NomeTipoDescrição
emailAddressStringO endereç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 especificado da lista de editores para o Form. Esse método não impede que os usuários acessem o Form se pertencerem a uma classe de usuários que tenham acesso geral, por exemplo, se o Form for compartilhado com todo o domínio do usuário ou se o Form estiver em um drive compartilhado que o usuário pode acessar.

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

Parâmetros

NomeTipoDescriçã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 em um subdomínio antes de responder.

Retornar

Boolean: true se o formulário exigir que os usuários façam login; false se não forem


setAcceptingResponses(enabled)

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

Parâmetros

NomeTipoDescrição
enabledBooleantrue se o formulário aceitar respostas; false se não precisar

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

setAllowResponseEdits(enabled)

Define se o formulário exibirá 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 no formulário gere um URL que pode ser usado para editar uma resposta.

Parâmetros

NomeTipoDescrição
enabledBooleantrue se o formulário mostrar um link "Editar" de resposta, false se não

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

setCollectEmail(collect)

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

Parâmetros

NomeTipoDescrição
collectBooleantrue se o formulário precisar coletar endereços de e-mail. false em caso negativo

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

setConfirmationMessage(message)

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

Parâmetros

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

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

setCustomClosedFormMessage(message)

Define que a mensagem 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

NomeTipoDescrição
messageStringa mensagem a ser exibida se o formulário não estiver aceitando respostas

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

setDescription(description)

Define a descrição do formulário.

Parâmetros

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

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

setDestination(type, id)

Define o destino no qual as respostas do formulário são salvas. 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.

Parâmetros

NomeTipoDescrição
typeDestinationTypeO tipo de destino da resposta do formulário
idStringo ID do destino da resposta do formulário

Retornar

Form: este Form para encadeamento

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, se ele for definido como falso, todas as opções de avaliação serão removidas de todas as perguntas.

As configurações do teste só estão disponíveis na nova IU do Formulários. Criar um teste permite que ele seja usado na nova IU.

Parâmetros

NomeTipoDescrição
enabledBooleantrue se os recursos de teste precisarem ser ativados para o formulário. false se não estiverem

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

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

NomeTipoDescrição
enabledBooleantrue se o formulário permitir apenas uma resposta por participante; false se não for possível

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

setProgressBar(enabled)

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

Parâmetros

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

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

setPublishingSummary(enabled)

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

Parâmetros

NomeTipoDescrição
enabledBooleantrue se o formulário mostrar um link "Ver respostas anteriores"; caso contrário, false

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

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. Usuários de outros tipos de Contas do Google não podem ter que fazer login.

Parâmetros

NomeTipoDescrição
requireLoginBooleantrue se o formulário exigir que os usuários façam login; false se não for necessário

Retornar

Form: o formulário atual (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

setShowLinkToRespondAgain(enabled)

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

Parâmetros

NomeTipoDescrição
enabledBooleantrue se o formulário mostrar um link "quot;Enviar outra resposta"; false se não

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

setShuffleQuestions(shuffle)

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

Parâmetros

NomeTipoDescrição
shuffleBooleantrue se a ordem das perguntas em cada página do formulário precisar ser aleatória, caso contrário, false.

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

setTitle(title)

Define o título do formulário.

Parâmetros

NomeTipoDescrição
titleStringo título novo do formulário

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

shortenFormUrl(url)

Converte um URL longo de um formulário em um URL curto. Uma exceção vai ser gerada se o URL longo não pertencer ao Formulários Google.

Parâmetros

NomeTipoDescrição
urlString

Retornar

String: um URL no formulário 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 os FormResponses fornecidos.

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 o código que verifica se as notas já existem antes de chamar submitGrades().

Parâmetros

NomeTipoDescriçã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