Forms Service

Formulários

Este serviço permite que os scripts criem, acessem e modifiquem os Formulários do Google.

// Create a new form, then add a checkbox question, a multiple choice question,
// a page break, then a date question and a grid of questions.
var form = FormApp.create('New Form');
var item = form.addCheckboxItem();
item.setTitle('What condiments would you like on your hot dog?');
item.setChoices([
        item.createChoice('Ketchup'),
        item.createChoice('Mustard'),
        item.createChoice('Relish')
    ]);
form.addMultipleChoiceItem()
    .setTitle('Do you prefer cats or dogs?')
    .setChoiceValues(['Cats','Dogs'])
    .showOtherOption(true);
form.addPageBreakItem()
    .setTitle('Getting to know you');
form.addDateItem()
    .setTitle('When were you born?');
form.addGridItem()
    .setTitle('Rate your interests')
    .setRows(['Cars', 'Computers', 'Celebrities'])
    .setColumns(['Boring', 'So-so', 'Interesting']);
Logger.log('Published URL: ' + form.getPublishedUrl());
Logger.log('Editor URL: ' + form.getEditUrl());

Aulas

NomeBreve descrição
AlignmentUm enum que representa os tipos compatíveis de alinhamento de imagem.
CheckboxGridItemUm item de pergunta, apresentado como uma grade de colunas e linhas, que permite que o participante selecione várias opções por linha em uma sequência de caixas de seleção.
CheckboxGridValidationUm DataValidation para um CheckboxGridItem.
CheckboxGridValidationBuilderUm DataValidationBuilder para um CheckboxGridValidation.
CheckboxItemUm item de pergunta que permite ao participante marcar uma ou mais caixas de seleção, bem como um campo "outro" opcional.
CheckboxValidationUm DataValidation para um CheckboxItem.
CheckboxValidationBuilderUm DataValidationBuilder para um CheckboxValidation.
ChoiceUma única escolha associada a um tipo de Item compatível com opções, como CheckboxItem, ListItem ou MultipleChoiceItem.
DateItemÉ um item de pergunta em que o participante pode indicar uma data.
DateTimeItemÉ um item de pergunta em que o participante pode indicar uma data e um horário.
DestinationTypeUm enum que representa os tipos compatíveis de destinos de formulário-resposta.
DurationItemÉ um item de pergunta que permite que o participante indique a duração.
FeedbackTypeUm enum que representa os tipos de feedback compatíveis.
FormUm formulário que contém propriedades e itens gerais.
FormAppPermite que um script abra um Form existente ou crie um novo.
FormResponseUma resposta ao formulário como um todo.
GridItemUm item de pergunta, apresentado como uma grade de colunas e linhas, que permite que o participante selecione uma opção por linha em uma sequência de botões de opção.
GridValidationUm DataValidation para um GridItem.
GridValidationBuilderUm DataValidationBuilder para um GridValidation.
ImageItemUm item de layout que exibe uma imagem.
ItemUm item de formulário genérico que contém propriedades comuns a todos os itens, como título e texto de ajuda.
ItemResponseUma resposta a um item de pergunta em um formulário.
ItemTypeUm enum que representa os tipos compatíveis de itens de formulário.
ListItemUm item de pergunta que permite que o participante selecione uma opção em uma lista suspensa.
MultipleChoiceItemUm item de pergunta que permite que o participante selecione uma opção em uma lista de botões de opção ou em um campo "outro" opcional.
PageBreakItemUm item de layout que marca o início de uma página.
PageNavigationTypeUm enum que representa os tipos compatíveis de navegação nas páginas.
ParagraphTextItemÉ um item de pergunta que permite que o participante insira um bloco de texto.
ParagraphTextValidationUm DataValidation para um ParagraphTextItem.
ParagraphTextValidationBuilderUm DataValidationBuilder para um ParagraphTextValidation.
QuizFeedbackA implementação de bean de um Feedback, que contém propriedades comuns a todos os comentários, como texto de exibição ou links.
QuizFeedbackBuilderO FeedbackBuilder base que contém setters para propriedades comuns a todos os feedbacks, como texto de exibição.
ScaleItemUm item de pergunta que permite que o participante escolha uma opção em uma sequência numerada de botões de opção.
SectionHeaderItemUm item de layout que indica visualmente o início de uma seção.
TextItemÉ um item de pergunta que permite que o participante insira uma única linha de texto.
TextValidationUm DataValidation para um TextItem.
TextValidationBuilderUm DataValidationBuilder para um TextValidation.
TimeItemÉ um item de pergunta em que o participante pode indicar um horário.
VideoItemUm item de layout que exibe um vídeo.

Alignment

Propriedades

PropriedadeTipoDescrição
LEFTEnumAlinhe a imagem à esquerda do formulário.
CENTEREnumAlinhe a imagem ao centro do formulário.
RIGHTEnumAlinhe a imagem à direita do formulário.

CheckboxGridItem

Métodos

MétodoTipo de retornoBreve descrição
clearValidation()CheckboxGridItemRemove qualquer validação de dados para este item da grade.
createResponse(responses)ItemResponseCria um novo ItemResponse para esse item de grade da caixa de seleção.
duplicate()CheckboxGridItemCria uma cópia deste item e anexa-a ao final do formulário.
getColumns()String[]Recebe os valores de cada coluna na grade.
getHelpText()StringRecebe o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
getId()IntegerObtém o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens no formulário.
getRows()String[]Recebe os valores de cada linha na grade.
getTitle()StringObtém o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como um ItemType.
isRequired()BooleanDetermina se o participante precisa responder à pergunta.
setColumns(columns)CheckboxGridItemDefine as colunas da grade com base em uma matriz de valores.
setHelpText(text)CheckboxGridItemDefine o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
setRequired(enabled)CheckboxGridItemDefine se o participante precisa responder à pergunta.
setRows(rows)CheckboxGridItemDefine as linhas da grade com base em uma matriz de valores.
setTitle(title)CheckboxGridItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
setValidation(validation)CheckboxGridItemDefine a validação de dados para este item de grade da caixa de seleção.

CheckboxGridValidation

CheckboxGridValidationBuilder

Métodos

MétodoTipo de retornoBreve descrição
requireLimitOneResponsePerColumn()CheckboxGridValidationBuilderExige um limite de uma resposta por coluna para um item da grade.

CheckboxItem

Métodos

MétodoTipo de retornoBreve descrição
clearValidation()CheckboxItemRemove qualquer validação de dados para esse item da caixa de seleção.
createChoice(value)ChoiceCria uma nova escolha.
createChoice(value, isCorrect)ChoiceCria uma nova escolha.
createResponse(responses)ItemResponseCria um novo ItemResponse para esse item da caixa de seleção.
duplicate()CheckboxItemCria uma cópia deste item e anexa-a ao final do formulário.
getChoices()Choice[]Recebe todas as opções de um item.
getFeedbackForCorrect()QuizFeedbackRetorna o feedback que é exibido aos participantes quando eles respondem corretamente a uma pergunta.
getFeedbackForIncorrect()QuizFeedbackRetorna o feedback exibido aos participantes quando eles respondem incorretamente a uma pergunta.
getHelpText()StringRecebe o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
getId()IntegerObtém o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens no formulário.
getPoints()IntegerRetorna a pontuação de um item que pode ser avaliado.
getTitle()StringObtém o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como um ItemType.
hasOtherOption()BooleanDetermina se o item tem uma opção "outro".
isRequired()BooleanDetermina se o participante precisa responder à pergunta.
setChoiceValues(values)CheckboxItemDefine as opções para um item de uma matriz de strings.
setChoices(choices)CheckboxItemDefine uma matriz de opções para um item.
setFeedbackForCorrect(feedback)CheckboxItemDefine o feedback que será exibido aos participantes quando eles responderem corretamente a uma pergunta.
setFeedbackForIncorrect(feedback)CheckboxItemDefine o feedback a ser mostrado aos participantes quando eles responderem incorretamente a uma pergunta.
setHelpText(text)CheckboxItemDefine o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
setPoints(points)CheckboxItemDefine o número de pontos de um item classificável.
setRequired(enabled)CheckboxItemDefine se o participante precisa responder à pergunta.
setTitle(title)CheckboxItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
setValidation(validation)CheckboxItemDefine a validação de dados para este item da caixa de seleção.
showOtherOption(enabled)CheckboxItemDefine se o item tem uma opção "outro".

CheckboxValidation

CheckboxValidationBuilder

Métodos

MétodoTipo de retornoBreve descrição
requireSelectAtLeast(number)CheckboxValidationBuilderSelecione pelo menos essa quantidade de opções.
requireSelectAtMost(number)CheckboxValidationBuilderSão necessárias no máximo tantas opções para serem selecionadas.
requireSelectExactly(number)CheckboxValidationBuilderExigir exatamente essa quantidade de opções para ser selecionado.

Choice

Métodos

MétodoTipo de retornoBreve descrição
getGotoPage()PageBreakItemRecebe o PageBreakItem definido como um destino GO_TO_PAGE se o participante selecionar essa opção e concluir a página atual.
getPageNavigationType()PageNavigationTypeRecebe o PageNavigationType que ocorre se o participante selecionar essa opção e concluir a página atual.
getValue()StringRecebe o valor da escolha, que os participantes veem como um rótulo ao visualizar o formulário.
isCorrectAnswer()BooleanRecebe se a opção é uma resposta correta para a pergunta.

DateItem

Métodos

MétodoTipo de retornoBreve descrição
createResponse(response)ItemResponseCria um novo ItemResponse para esse item de data.
duplicate()DateItemCria uma cópia deste item e anexa-a ao final do formulário.
getGeneralFeedback()QuizFeedbackRetorna o feedback mostrado aos participantes quando eles respondem a uma pergunta de avaliação.
getHelpText()StringRecebe o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
getId()IntegerObtém o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens no formulário.
getPoints()IntegerRetorna a pontuação de um item que pode ser avaliado.
getTitle()StringObtém o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como um ItemType.
includesYear()BooleanDetermina se o item de data inclui uma opção de ano.
isRequired()BooleanDetermina se o participante precisa responder à pergunta.
setGeneralFeedback(feedback)DateItemDefine o feedback a ser exibido aos participantes quando eles respondem a uma pergunta que não tem uma resposta correta ou incorreta (ou seja, perguntas que exigem avaliação manual).
setHelpText(text)DateItemDefine o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
setIncludesYear(enableYear)DateItemDefine se o item de data inclui uma configuração de ano.
setPoints(points)DateItemDefine o número de pontos de um item classificável.
setRequired(enabled)DateItemDefine se o participante precisa responder à pergunta.
setTitle(title)DateItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).

DateTimeItem

Métodos

MétodoTipo de retornoBreve descrição
createResponse(response)ItemResponseCria um novo ItemResponse para esse item de data e hora.
duplicate()DateTimeItemCria uma cópia deste item e anexa-a ao final do formulário.
getGeneralFeedback()QuizFeedbackRetorna o feedback mostrado aos participantes quando eles respondem a uma pergunta de avaliação.
getHelpText()StringRecebe o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
getId()IntegerObtém o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens no formulário.
getPoints()IntegerRetorna a pontuação de um item que pode ser avaliado.
getTitle()StringObtém o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como um ItemType.
includesYear()BooleanDetermina se o item de data inclui uma opção de ano.
isRequired()BooleanDetermina se o participante precisa responder à pergunta.
setGeneralFeedback(feedback)DateTimeItemDefine o feedback a ser exibido aos participantes quando eles respondem a uma pergunta que não tem uma resposta correta ou incorreta (ou seja, perguntas que exigem avaliação manual).
setHelpText(text)DateTimeItemDefine o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
setIncludesYear(enableYear)DateTimeItemDefine se o item de data inclui uma configuração de ano.
setPoints(points)DateTimeItemDefine o número de pontos de um item classificável.
setRequired(enabled)DateTimeItemDefine se o participante precisa responder à pergunta.
setTitle(title)DateTimeItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).

DestinationType

Propriedades

PropriedadeTipoDescrição
SPREADSHEETEnumUm arquivo do Planilhas Google como destino das respostas do formulário

DurationItem

Métodos

MétodoTipo de retornoBreve descrição
createResponse(hours, minutes, seconds)ItemResponseCria um novo ItemResponse para esse item de data.
duplicate()DurationItemCria uma cópia deste item e anexa-a ao final do formulário.
getGeneralFeedback()QuizFeedbackRetorna o feedback mostrado aos participantes quando eles respondem a uma pergunta de avaliação.
getHelpText()StringRecebe o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
getId()IntegerObtém o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens no formulário.
getPoints()IntegerRetorna a pontuação de um item que pode ser avaliado.
getTitle()StringObtém o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como um ItemType.
isRequired()BooleanDetermina se o participante precisa responder à pergunta.
setGeneralFeedback(feedback)DurationItemDefine o feedback a ser exibido aos participantes quando eles respondem a uma pergunta que não tem uma resposta correta ou incorreta (ou seja, perguntas que exigem avaliação manual).
setHelpText(text)DurationItemDefine o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
setPoints(points)DurationItemDefine o número de pontos de um item classificável.
setRequired(enabled)DurationItemDefine se o participante precisa responder à pergunta.
setTitle(title)DurationItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).

FeedbackType

Propriedades

PropriedadeTipoDescrição
CORRECTEnumFeedback exibido automaticamente aos participantes para uma pergunta respondida corretamente.
INCORRECTEnumFeedback exibido automaticamente aos participantes para uma pergunta respondida incorretamente.
GENERALEnumFeedback exibido automaticamente aos participantes quando eles enviam a resposta.

Form

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 que o participante selecione 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 "outro" opcional.
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 uma data e um horário.
addDurationItem()DurationItemAnexa um novo item de pergunta que permite que o participante indique a duração.
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 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 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 "outro".
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 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 uma hora 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 ao formulário.
deleteAllResponses()FormExclui todas as respostas enviadas do armazenamento de respostas do formulário.
deleteItem(index)voidExclui o item em um determinado índice entre todos os itens do 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 é exibida se o formulário não estiver aceitando respostas ou uma string vazia se nenhuma mensagem personalizada estiver definida.
getDescription()StringObtém a descrição do formulário.
getDestinationId()StringObtém o ID do destino da resposta do formulário.
getDestinationType()DestinationTypeRecebe o tipo do destino da resposta do formulário.
getEditUrl()StringObtém o URL que pode ser usado para acessar o modo de edição do formulário.
getEditors()User[]Obtém a lista de editores para este Form.
getId()StringObtém o ID do formulário.
getItemById(id)ItemObtém o item com um determinado ID.
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()StringObtém 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()StringObtém o URL que pode ser usado para visualizar um resumo das respostas do formulário.
getTitle()StringObtém 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 participante preencher o formulário.
isAcceptingResponses()BooleanDetermina se o formulário está aceitando respostas.
isPublishingSummary()BooleanDetermina se o formulário exibe um link para visualizar um resumo das respostas depois que um participante preenche o formulário.
isQuiz()BooleanDetermina 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.
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 do Form.
removeEditor(user)FormRemove o usuário especificado 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 exibirá um link para editar uma resposta após o envio.
setCollectEmail(collect)FormDefine se o formulário coleta 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 em que 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 exibirá um link para visualizar um resumo das respostas depois que o participante enviar o formulário.
setRequireLogin(requireLogin)FormDefine se o formulário exige que os participantes façam login em uma conta no mesmo domínio ou subdomínio antes de responder.
setShowLinkToRespondAgain(enabled)FormDefine se o formulário exibirá 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 fornecido.

FormApp

Propriedades

PropriedadeTipoDescrição
AlignmentAlignmentUma enumeração dos tipos de alinhamento de imagem.
DestinationTypeDestinationTypeUma enumeração de tipos de destinos que podem armazenar respostas de formulários.
FeedbackTypeFeedbackTypeUma enumeração dos tipos de formulário Feedbacks.
ItemTypeItemTypeUma enumeração dos tipos de formulário Items.
PageNavigationTypePageNavigationTypeUma enumeração dos possíveis comportamentos para a navegação nas páginas.

Métodos

MétodoTipo de retornoBreve descrição
create(title)FormCria e retorna um novo Form.
createCheckboxGridValidation()CheckboxGridValidationBuilderRetorna uma instância de um CheckboxGridValidationBuilder que pode ser usado para definir a validação em um CheckboxGridItem.
createCheckboxValidation()CheckboxValidationBuilderRetorna uma instância de um CheckboxValidationBuilder que pode ser usado para definir a validação em um CheckboxItem.
createFeedback()QuizFeedbackBuilderRetorna uma instância de um QuizFeedbackBuilder, que pode ser usado para definir feedback sobre um Item com classificação.
createGridValidation()GridValidationBuilderRetorna uma instância de um GridValidationBuilder que pode ser usado para definir a validação em um GridItem.
createParagraphTextValidation()ParagraphTextValidationBuilderRetorna uma instância de um ParagraphTextValidationBuilder que pode ser usado para definir a validação em um ParagraphTextItem.
createTextValidation()TextValidationBuilderRetorna uma instância de TextValidationBuilder que pode ser usada para definir a validação em um TextItem.
getActiveForm()FormRetorna o formulário ao qual o script é vinculado ao contêiner.
getUi()UiRetorna uma instância do ambiente de interface do usuário do editor de formulários que permite que o script adicione recursos como menus, caixas de diálogo e barras laterais.
openById(id)FormRetorna o Form com o ID especificado.
openByUrl(url)FormRetorna Form com o URL especificado.

FormResponse

Métodos

MétodoTipo de retornoBreve descrição
getEditResponseUrl()StringGera um URL que pode ser usado para editar uma resposta que já foi enviada.
getGradableItemResponses()ItemResponse[]Recebe todas as respostas de item contidas em uma resposta de formulário, na mesma ordem em que os itens aparecem no formulário.
getGradableResponseForItem(item)ItemResponseObtém a resposta do item contida em uma resposta de formulário para um determinado item.
getId()StringObtém o ID da resposta do formulário.
getItemResponses()ItemResponse[]Recebe todas as respostas de item contidas em uma resposta de formulário, na mesma ordem em que os itens aparecem no formulário.
getRespondentEmail()StringRecebe o endereço de e-mail da pessoa que enviou uma resposta se a configuração Form.setCollectEmail(collect) estiver ativada.
getResponseForItem(item)ItemResponseObtém a resposta do item contida nessa resposta de formulário para um determinado item.
getTimestamp()DateRecebe o carimbo de data/hora de um envio de resposta do formulário.
submit()FormResponseEnvia a resposta.
toPrefilledUrl()StringGera um URL para o formulário em que as respostas são preenchidas automaticamente com base nas respostas contidas neste formulário.
withItemGrade(gradedResponse)FormResponseAdiciona as notas da resposta do item a uma resposta do formulário.
withItemResponse(response)FormResponseAdiciona a resposta do item especificada a uma resposta do formulário.

GridItem

Métodos

MétodoTipo de retornoBreve descrição
clearValidation()GridItemRemove qualquer validação de dados para este item da grade.
createResponse(responses)ItemResponseCria um novo ItemResponse para esse item da grade.
duplicate()GridItemCria uma cópia deste item e anexa-a ao final do formulário.
getColumns()String[]Recebe os valores de cada coluna na grade.
getHelpText()StringRecebe o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
getId()IntegerObtém o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens no formulário.
getRows()String[]Recebe os valores de cada linha na grade.
getTitle()StringObtém o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como um ItemType.
isRequired()BooleanDetermina se o participante precisa responder à pergunta.
setColumns(columns)GridItemDefine as colunas da grade com base em uma matriz de valores.
setHelpText(text)GridItemDefine o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
setRequired(enabled)GridItemDefine se o participante precisa responder à pergunta.
setRows(rows)GridItemDefine as linhas da grade com base em uma matriz de valores.
setTitle(title)GridItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
setValidation(validation)GridItemDefine a validação de dados para este item da grade.

GridValidation

GridValidationBuilder

Métodos

MétodoTipo de retornoBreve descrição
requireLimitOneResponsePerColumn()GridValidationBuilderExige um limite de uma resposta por coluna para um item da grade.

ImageItem

Métodos

MétodoTipo de retornoBreve descrição
duplicate()ImageItemCria uma cópia deste item e anexa-a ao final do formulário.
getAlignment()AlignmentObtém o alinhamento horizontal da imagem.
getHelpText()StringRecebe o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
getId()IntegerObtém o identificador exclusivo do item.
getImage()BlobObtém a imagem que está atualmente atribuída ao item.
getIndex()IntegerRecebe o índice do item entre todos os itens no formulário.
getTitle()StringObtém o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como um ItemType.
getWidth()IntegerObtém a largura da imagem em pixels.
setAlignment(alignment)ImageItemDefine o alinhamento horizontal da imagem.
setHelpText(text)ImageItemDefine o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
setImage(image)ImageItemDefine a própria imagem.
setTitle(title)ImageItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
setWidth(width)ImageItemDefine a largura da imagem em pixels.

Item

Métodos

MétodoTipo de retornoBreve descrição
asCheckboxGridItem()CheckboxGridItemRetorna o item como um item de grade da caixa de seleção.
asCheckboxItem()CheckboxItemRetorna o item como um item de caixa de seleção.
asDateItem()DateItemRetorna o item como um item de data.
asDateTimeItem()DateTimeItemRetorna o item como um item de data e hora.
asDurationItem()DurationItemRetorna o item como um item de duração.
asGridItem()GridItemRetorna o item como um item da grade.
asImageItem()ImageItemRetorna o item como um item de imagem.
asListItem()ListItemRetorna o item como um item da lista.
asMultipleChoiceItem()MultipleChoiceItemRetorna o item como um item de múltipla escolha.
asPageBreakItem()PageBreakItemRetorna o item como um item de quebra de página.
asParagraphTextItem()ParagraphTextItemRetorna o item como um item de texto de parágrafo.
asScaleItem()ScaleItemRetorna o item como um item de escala.
asSectionHeaderItem()SectionHeaderItemRetorna o item como um item de cabeçalho da seção.
asTextItem()TextItemRetorna o item como um item de texto.
asTimeItem()TimeItemRetorna o item como um item de tempo.
asVideoItem()VideoItemRetorna o item como um item de vídeo.
duplicate()ItemCria uma cópia deste item e anexa-a ao final do formulário.
getHelpText()StringRecebe o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
getId()IntegerObtém o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens no formulário.
getTitle()StringObtém o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como um ItemType.
setHelpText(text)ItemDefine o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
setTitle(title)ItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).

ItemResponse

Métodos

MétodoTipo de retornoBreve descrição
getFeedback()ObjectRecebe o feedback fornecido para a resposta enviada pelo participante.
getItem()ItemRecebe o item da pergunta que essa resposta responde.
getResponse()ObjectRecebe a resposta que o participante enviou.
getScore()ObjectRecebe a pontuação da resposta enviada pelo participante.
setFeedback(feedback)ItemResponseDefine o feedback que deve ser exibido para a resposta enviada do participante.
setScore(score)ItemResponseDefine a pontuação da resposta enviada do participante.

ItemType

Propriedades

PropriedadeTipoDescrição
CHECKBOXEnumUm item de pergunta que permite ao participante marcar uma ou mais caixas de seleção, bem como um campo "outro" opcional.
CHECKBOX_GRIDEnumUm item de pergunta, apresentado como uma grade de colunas e linhas, que permite que o participante selecione várias opções por linha em uma sequência de caixas de seleção.
DATEEnumÉ um item de pergunta em que o participante pode indicar uma data.
DATETIMEEnumÉ um item de pergunta em que o participante pode indicar uma data e um horário.
DURATIONEnumÉ um item de pergunta que permite que o participante indique a duração.
GRIDEnumUm item de pergunta, apresentado como uma grade de colunas e linhas, que permite que o participante selecione uma opção por linha em uma sequência de botões de opção.
IMAGEEnumUm item de layout que exibe uma imagem.
LISTEnumUm item de pergunta que permite que o participante selecione uma opção em uma lista suspensa.
MULTIPLE_CHOICEEnumUm item de pergunta que permite que o participante selecione uma opção em uma lista de botões de opção ou em um campo "outro" opcional.
PAGE_BREAKEnumUm item de layout que marca o início de uma página.
PARAGRAPH_TEXTEnumÉ um item de pergunta que permite que o participante insira um bloco de texto.
SCALEEnumÉ um item de pergunta que permite ao participante escolher uma opção em uma sequência numerada de botões de opção.
SECTION_HEADEREnumUm item de layout que indica visualmente o início de uma seção.
TEXTEnumÉ um item de pergunta que permite que o participante insira uma única linha de texto.
TIMEEnumÉ um item de pergunta em que o participante pode indicar um horário.
VIDEOEnumUm item de layout que exibe um vídeo do YouTube.
FILE_UPLOADEnumÉ um item de pergunta em que o participante pode fazer upload de um arquivo.

ListItem

Métodos

MétodoTipo de retornoBreve descrição
createChoice(value)ChoiceCria uma nova escolha.
createChoice(value, isCorrect)ChoiceCria uma nova escolha.
createChoice(value, navigationItem)ChoiceCria uma nova opção com uma opção de navegação de página que pula para um determinado item de quebra de página.
createChoice(value, navigationType)ChoiceCria uma nova opção com uma opção de navegação na página.
createResponse(response)ItemResponseCria um novo ItemResponse para esse item da lista.
duplicate()ListItemCria uma cópia deste item e anexa-a ao final do formulário.
getChoices()Choice[]Recebe todas as opções de um item.
getFeedbackForCorrect()QuizFeedbackRetorna o feedback que é exibido aos participantes quando eles respondem corretamente a uma pergunta.
getFeedbackForIncorrect()QuizFeedbackRetorna o feedback exibido aos participantes quando eles respondem incorretamente a uma pergunta.
getHelpText()StringRecebe o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
getId()IntegerObtém o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens no formulário.
getPoints()IntegerRetorna a pontuação de um item que pode ser avaliado.
getTitle()StringObtém o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como um ItemType.
isRequired()BooleanDetermina se o participante precisa responder à pergunta.
setChoiceValues(values)ListItemDefine as opções para um item de uma matriz de strings.
setChoices(choices)ListItemDefine uma matriz de opções para um item.
setFeedbackForCorrect(feedback)ListItemDefine o feedback que será exibido aos participantes quando eles responderem corretamente a uma pergunta.
setFeedbackForIncorrect(feedback)ListItemDefine o feedback a ser mostrado aos participantes quando eles responderem incorretamente a uma pergunta.
setHelpText(text)ListItemDefine o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
setPoints(points)ListItemDefine o número de pontos de um item classificável.
setRequired(enabled)ListItemDefine se o participante precisa responder à pergunta.
setTitle(title)ListItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).

MultipleChoiceItem

Métodos

MétodoTipo de retornoBreve descrição
createChoice(value)ChoiceCria uma nova escolha.
createChoice(value, isCorrect)ChoiceCria uma nova escolha.
createChoice(value, navigationItem)ChoiceCria uma nova opção com uma opção de navegação de página que pula para um determinado item de quebra de página.
createChoice(value, navigationType)ChoiceCria uma nova opção com uma opção de navegação na página.
createResponse(response)ItemResponseCria um novo ItemResponse para esse item de múltipla escolha.
duplicate()MultipleChoiceItemCria uma cópia deste item e anexa-a ao final do formulário.
getChoices()Choice[]Recebe todas as opções de um item.
getFeedbackForCorrect()QuizFeedbackRetorna o feedback que é exibido aos participantes quando eles respondem corretamente a uma pergunta.
getFeedbackForIncorrect()QuizFeedbackRetorna o feedback exibido aos participantes quando eles respondem incorretamente a uma pergunta.
getHelpText()StringRecebe o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
getId()IntegerObtém o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens no formulário.
getPoints()IntegerRetorna a pontuação de um item que pode ser avaliado.
getTitle()StringObtém o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como um ItemType.
hasOtherOption()BooleanDetermina se o item tem uma opção "outro".
isRequired()BooleanDetermina se o participante precisa responder à pergunta.
setChoiceValues(values)MultipleChoiceItemDefine as opções para um item de uma matriz de strings.
setChoices(choices)MultipleChoiceItemDefine uma matriz de opções para um item.
setFeedbackForCorrect(feedback)MultipleChoiceItemDefine o feedback que será exibido aos participantes quando eles responderem corretamente a uma pergunta.
setFeedbackForIncorrect(feedback)MultipleChoiceItemDefine o feedback a ser mostrado aos participantes quando eles responderem incorretamente a uma pergunta.
setHelpText(text)MultipleChoiceItemDefine o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
setPoints(points)MultipleChoiceItemDefine o número de pontos de um item classificável.
setRequired(enabled)MultipleChoiceItemDefine se o participante precisa responder à pergunta.
setTitle(title)MultipleChoiceItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
showOtherOption(enabled)MultipleChoiceItemDefine se o item tem uma opção "outro".

PageBreakItem

Métodos

MétodoTipo de retornoBreve descrição
duplicate()PageBreakItemCria uma cópia deste item e anexa-a ao final do formulário.
getGoToPage()PageBreakItemRecebe o PageBreakItem para o qual o formulário pulará após a conclusão da página antes dessa quebra (ou seja, ao alcançar essa quebra de página por progressão linear normal no formulário).
getHelpText()StringRecebe o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
getId()IntegerObtém o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens no formulário.
getPageNavigationType()PageNavigationTypeRecebe o tipo de navegação da página que ocorre após a conclusão da página antes dessa quebra de página, ou seja, ao alcançar essa quebra de página por progressão linear normal pelo formulário.
getTitle()StringObtém o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como um ItemType.
setGoToPage(goToPageItem)PageBreakItemDefine o salto para a página após o fim dela antes da quebra de página (ou seja, ao alcançar essa quebra de página por progressão linear normal pelo formulário).
setGoToPage(navigationType)PageBreakItemDefine o tipo de navegação da página que ocorre após a conclusão da página antes dessa quebra de página, ou seja, ao alcançar essa quebra de página por progressão linear normal pelo formulário.
setHelpText(text)PageBreakItemDefine o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
setTitle(title)PageBreakItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).

Propriedades

PropriedadeTipoDescrição
CONTINUEEnumContinuar para a próxima página do formulário após concluir a página atual.
GO_TO_PAGEEnumIr para uma página específica do formulário após completar a página atual.
RESTARTEnumReinicie o formulário desde o início, sem apagar as respostas inseridas até agora, depois de preencher a página atual.
SUBMITEnumEnvie a resposta do formulário depois de preencher a página atual.

ParagraphTextItem

Métodos

MétodoTipo de retornoBreve descrição
clearValidation()ParagraphTextItemRemove qualquer validação de dados para este item de texto do parágrafo.
createResponse(response)ItemResponseCria um novo ItemResponse para esse item de texto de parágrafo.
duplicate()ParagraphTextItemCria uma cópia deste item e anexa-a ao final do formulário.
getGeneralFeedback()QuizFeedbackRetorna o feedback mostrado aos participantes quando eles respondem a uma pergunta de avaliação.
getHelpText()StringRecebe o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
getId()IntegerObtém o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens no formulário.
getPoints()IntegerRetorna a pontuação de um item que pode ser avaliado.
getTitle()StringObtém o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como um ItemType.
isRequired()BooleanDetermina se o participante precisa responder à pergunta.
setGeneralFeedback(feedback)ParagraphTextItemDefine o feedback a ser exibido aos participantes quando eles respondem a uma pergunta que não tem uma resposta correta ou incorreta (ou seja, perguntas que exigem avaliação manual).
setHelpText(text)ParagraphTextItemDefine o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
setPoints(points)ParagraphTextItemDefine o número de pontos de um item classificável.
setRequired(enabled)ParagraphTextItemDefine se o participante precisa responder à pergunta.
setTitle(title)ParagraphTextItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
setValidation(validation)ParagraphTextItemDefine a validação de dados para o item de texto do parágrafo.

ParagraphTextValidation

ParagraphTextValidationBuilder

Métodos

MétodoTipo de retornoBreve descrição
requireTextContainsPattern(pattern)ParagraphTextValidationBuilderExige uma resposta para conter um padrão.
requireTextDoesNotContainPattern(pattern)ParagraphTextValidationBuilderExige resposta para não conter um padrão.
requireTextDoesNotMatchPattern(pattern)ParagraphTextValidationBuilderExige resposta para não corresponder ao padrão.
requireTextLengthGreaterThanOrEqualTo(number)ParagraphTextValidationBuilderRequer que o tamanho da resposta seja maior ou igual ao valor.
requireTextLengthLessThanOrEqualTo(number)ParagraphTextValidationBuilderRequer que o tamanho da resposta seja menor que o valor.
requireTextMatchesPattern(pattern)ParagraphTextValidationBuilderRequer uma resposta para corresponder ao padrão.

QuizFeedback

Métodos

MétodoTipo de retornoBreve descrição
getLinkUrls()String[]Obtém uma lista dos URLs associados ao Feedback.
getText()StringObtém o texto de exibição do Feedback.

QuizFeedbackBuilder

Métodos

MétodoTipo de retornoBreve descrição
addLink(url)QuizFeedbackBuilderAdiciona um link ao material complementar do feedback.
addLink(url, displayText)QuizFeedbackBuilderAdiciona um link ao material complementar do feedback.
build()QuizFeedbackCria um feedback do tipo correspondente para esse construtor.
copy()QuizFeedbackBuilderRetorna uma cópia deste construtor.
setText(text)QuizFeedbackBuilderDefine o texto do feedback.

ScaleItem

Métodos

MétodoTipo de retornoBreve descrição
createResponse(response)ItemResponseCria um novo ItemResponse para esse item de escala.
duplicate()ScaleItemCria uma cópia deste item e anexa-a ao final do formulário.
getGeneralFeedback()QuizFeedbackRetorna o feedback mostrado aos participantes quando eles respondem a uma pergunta de avaliação.
getHelpText()StringRecebe o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
getId()IntegerObtém o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens no formulário.
getLeftLabel()StringObtém o rótulo para o limite inferior da escala, se houver.
getLowerBound()IntegerRecebe o limite inferior da escala.
getPoints()IntegerRetorna a pontuação de um item que pode ser avaliado.
getRightLabel()StringObtém o rótulo para o limite superior da escala, se houver.
getTitle()StringObtém o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como um ItemType.
getUpperBound()IntegerRecebe o limite superior da escala.
isRequired()BooleanDetermina se o participante precisa responder à pergunta.
setBounds(lower, upper)ScaleItemDefine os limites inferior e superior da escala.
setGeneralFeedback(feedback)ScaleItemDefine o feedback a ser exibido aos participantes quando eles respondem a uma pergunta que não tem uma resposta correta ou incorreta (ou seja, perguntas que exigem avaliação manual).
setHelpText(text)ScaleItemDefine o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
setLabels(lower, upper)ScaleItemDefine rótulos para os limites inferior e superior da escala.
setPoints(points)ScaleItemDefine o número de pontos de um item classificável.
setRequired(enabled)ScaleItemDefine se o participante precisa responder à pergunta.
setTitle(title)ScaleItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).

SectionHeaderItem

Métodos

MétodoTipo de retornoBreve descrição
duplicate()SectionHeaderItemCria uma cópia deste item e anexa-a ao final do formulário.
getHelpText()StringRecebe o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
getId()IntegerObtém o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens no formulário.
getTitle()StringObtém o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como um ItemType.
setHelpText(text)SectionHeaderItemDefine o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
setTitle(title)SectionHeaderItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).

TextItem

Métodos

MétodoTipo de retornoBreve descrição
clearValidation()TextItemRemove qualquer validação de dados para este item de texto.
createResponse(response)ItemResponseCria um novo ItemResponse para esse item de texto.
duplicate()TextItemCria uma cópia deste item e anexa-a ao final do formulário.
getGeneralFeedback()QuizFeedbackRetorna o feedback mostrado aos participantes quando eles respondem a uma pergunta de avaliação.
getHelpText()StringRecebe o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
getId()IntegerObtém o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens no formulário.
getPoints()IntegerRetorna a pontuação de um item que pode ser avaliado.
getTitle()StringObtém o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como um ItemType.
isRequired()BooleanDetermina se o participante precisa responder à pergunta.
setGeneralFeedback(feedback)TextItemDefine o feedback a ser exibido aos participantes quando eles respondem a uma pergunta que não tem uma resposta correta ou incorreta (ou seja, perguntas que exigem avaliação manual).
setHelpText(text)TextItemDefine o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
setPoints(points)TextItemDefine o número de pontos de um item classificável.
setRequired(enabled)TextItemDefine se o participante precisa responder à pergunta.
setTitle(title)TextItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
setValidation(validation)TextItemDefine a validação de dados para este item de texto.

TextValidation

TextValidationBuilder

Métodos

MétodoTipo de retornoBreve descrição
requireNumber()TextValidationBuilderExige que o item de texto seja um número.
requireNumberBetween(start, end)TextValidationBuilderExige que o item de texto seja um número entre o início e o fim, inclusive.
requireNumberEqualTo(number)TextValidationBuilderExige que o item de texto seja um número igual ao valor especificado.
requireNumberGreaterThan(number)TextValidationBuilderExige que o item de texto seja um número maior que o valor especificado.
requireNumberGreaterThanOrEqualTo(number)TextValidationBuilderExige que o item de texto seja um número maior ou igual ao valor especificado.
requireNumberLessThan(number)TextValidationBuilderExige que o item de texto seja um número menor que o valor especificado.
requireNumberLessThanOrEqualTo(number)TextValidationBuilderExige que o item de texto seja um número menor ou igual ao valor especificado.
requireNumberNotBetween(start, end)TextValidationBuilderExige que o item de texto seja um número que não esteja entre o início e o fim, inclusive.
requireNumberNotEqualTo(number)TextValidationBuilderExige que o item de texto seja um número diferente do valor especificado.
requireTextContainsPattern(pattern)TextValidationBuilderExige uma resposta para conter um padrão.
requireTextDoesNotContainPattern(pattern)TextValidationBuilderExige resposta para não conter um padrão.
requireTextDoesNotMatchPattern(pattern)TextValidationBuilderExige resposta para não corresponder ao padrão.
requireTextIsEmail()TextValidationBuilderRequer que o item de texto seja um endereço de e-mail.
requireTextIsUrl()TextValidationBuilderExige que o item de texto seja um URL.
requireTextLengthGreaterThanOrEqualTo(number)TextValidationBuilderRequer que o tamanho da resposta seja maior ou igual ao valor.
requireTextLengthLessThanOrEqualTo(number)TextValidationBuilderRequer que o tamanho da resposta seja menor que o valor.
requireTextMatchesPattern(pattern)TextValidationBuilderRequer uma resposta para corresponder ao padrão.
requireWholeNumber()TextValidationBuilderExige que o item de texto seja um número inteiro.

TimeItem

Métodos

MétodoTipo de retornoBreve descrição
createResponse(hour, minute)ItemResponseCria um novo ItemResponse para esse item de tempo.
duplicate()TimeItemCria uma cópia deste item e anexa-a ao final do formulário.
getGeneralFeedback()QuizFeedbackRetorna o feedback mostrado aos participantes quando eles respondem a uma pergunta de avaliação.
getHelpText()StringRecebe o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
getId()IntegerObtém o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens no formulário.
getPoints()IntegerRetorna a pontuação de um item que pode ser avaliado.
getTitle()StringObtém o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como um ItemType.
isRequired()BooleanDetermina se o participante precisa responder à pergunta.
setGeneralFeedback(feedback)TimeItemDefine o feedback a ser exibido aos participantes quando eles respondem a uma pergunta que não tem uma resposta correta ou incorreta (ou seja, perguntas que exigem avaliação manual).
setHelpText(text)TimeItemDefine o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
setPoints(points)TimeItemDefine o número de pontos de um item classificável.
setRequired(enabled)TimeItemDefine se o participante precisa responder à pergunta.
setTitle(title)TimeItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).

VideoItem

Métodos

MétodoTipo de retornoBreve descrição
duplicate()VideoItemCria uma cópia deste item e anexa-a ao final do formulário.
getAlignment()AlignmentObtém o alinhamento horizontal do vídeo.
getHelpText()StringRecebe o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
getId()IntegerObtém o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens no formulário.
getTitle()StringObtém o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como um ItemType.
getWidth()IntegerObtém a largura do vídeo em pixels.
setAlignment(alignment)VideoItemDefine o alinhamento horizontal do vídeo.
setHelpText(text)VideoItemDefine o texto de ajuda do item, às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems.
setTitle(title)VideoItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
setVideoUrl(youtubeUrl)VideoItemDefine o próprio vídeo a partir de um determinado URL ou ID do vídeo do YouTube.
setWidth(width)VideoItemDefine a largura do vídeo em pixels.