Forms Service

Formulários

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

// Create a new unpublished form, then add a checkbox question, a multiple choice question,
// a page break, then a date question and a grid of questions, then publish the form and share
// with responders.
var form = FormApp.create('New Form', /* isPublished= */ false);
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']);

form.setPublished(true);
form.addPublishedReaders(['user@example.com', 'group@example.com']);

Logger.log('Published URL: ' + form.getPublishedUrl());
Logger.log('Editor URL: ' + form.getEditUrl());

Classes

NomeBreve descrição
AlignmentUma enumeração que representa os tipos compatíveis de alinhamento de imagem.
CheckboxGridItemUm item de pergunta, apresentado como uma grade de colunas e linhas, que permite ao participante selecionar 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 selecionar uma ou mais caixas de seleção, além de um campo "outro" opcional.
CheckboxValidationUm DataValidation para um CheckboxItem.
CheckboxValidationBuilderUm DataValidationBuilder para um CheckboxValidation.
ChoiceUma única opção associada a um tipo de Item que aceita opções, como CheckboxItem, ListItem ou MultipleChoiceItem.
DateItemUm item de pergunta que permite ao respondente indicar uma data.
DateTimeItemUma questão que permite ao participante indicar uma data e hora.
DestinationTypeUma enumeração que representa os tipos compatíveis de destinos de respostas do formulário.
DurationItemUm item de pergunta que permite ao entrevistado indicar um período.
FeedbackTypeUma enumeração que representa os tipos de feedback aceitos.
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 ao participante selecionar 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 mostra 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.
ItemTypeUma enumeração que representa os tipos de itens de formulário aceitos.
ListItemUma pergunta que permite ao participante selecionar uma opção em uma lista suspensa.
MultipleChoiceItemUma pergunta que permite ao participante selecionar uma opção em uma lista de botões de opção ou um campo "Outro" opcional.
PageBreakItemUm item de layout que marca o início de uma página.
PageNavigationTypeUma enumeração que representa os tipos de navegação de página compatíveis.
ParagraphTextItemUm item de pergunta que permite que o entrevistado insira um bloco de texto.
ParagraphTextValidationUm DataValidation para um ParagraphTextItem.
ParagraphTextValidationBuilderUm DataValidationBuilder para um ParagraphTextValidation.
QuizFeedbackA implementação de um bean de Feedback, que contém propriedades comuns a todos os feedbacks, como texto ou links de exibição.
QuizFeedbackBuilderO FeedbackBuilder básico que contém setters para propriedades comuns a todos os feedbacks, como texto de exibição.
RatingIconTypeUma enumeração que representa os tipos de ícones de classificação compatíveis.
RatingItemUma pergunta que permite ao participante dar uma classificaçã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.
TextItemUm item de pergunta que permite ao respondente inserir uma única linha de texto.
TextValidationUm DataValidation para um TextItem.
TextValidationBuilderUm DataValidationBuilder para um TextValidation.
TimeItemUma pergunta que permite ao participante indicar um horário do dia.
VideoItemUm item de layout que mostra 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 ao lado direito do formulário.

CheckboxGridItem

Métodos

MétodoTipo de retornoBreve descrição
clearValidation()CheckboxGridItemRemove qualquer validação de dados do item de grade.
createResponse(responses)ItemResponseCria um novo ItemResponse para este item de grade de caixa de seleção.
duplicate()CheckboxGridItemCria uma cópia deste item e a anexa ao final do formulário.
getColumns()String[]Recebe os valores de todas as colunas 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()IntegerRecebe o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getRows()String[]Recebe os valores de cada linha na grade.
getTitle()StringRecebe 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 de caixa de seleção.

CheckboxGridValidation

CheckboxGridValidationBuilder

Métodos

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

CheckboxItem

Métodos

MétodoTipo de retornoBreve descrição
clearValidation()CheckboxItemRemove qualquer validação de dados para este item de caixa de seleção.
createChoice(value)ChoiceCria uma nova opção.
createChoice(value, isCorrect)ChoiceCria uma nova opção.
createResponse(responses)ItemResponseCria um novo ItemResponse para este item de caixa de seleção.
duplicate()CheckboxItemCria uma cópia deste item e a anexa ao final do formulário.
getChoices()Choice[]Recebe todas as opções de um item.
getFeedbackForCorrect()QuizFeedback|nullRetorna o feedback mostrado aos participantes quando eles respondem corretamente a uma pergunta.
getFeedbackForIncorrect()QuizFeedback|nullRetorna o feedback mostrado 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()IntegerRecebe o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getPoints()IntegerRetorna o valor de um item avaliável.
getTitle()StringRecebe 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 "Outros".
isRequired()BooleanDetermina se o participante precisa responder à pergunta.
setChoiceValues(values)CheckboxItemDefine as opções de um item em uma matriz de strings.
setChoices(choices)CheckboxItemDefine uma matriz de opções para um item.
setFeedbackForCorrect(feedback)CheckboxItemDefine o feedback que será mostrado aos participantes quando eles responderem corretamente a uma pergunta.
setFeedbackForIncorrect(feedback)CheckboxItemDefine o feedback que 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 que um item avaliável vale.
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 de caixa de seleção.
showOtherOption(enabled)CheckboxItemDefine se o item tem uma opção "Outros".

CheckboxValidation

CheckboxValidationBuilder

Métodos

MétodoTipo de retornoBreve descrição
requireSelectAtLeast(number)CheckboxValidationBuilderExigir que pelo menos este número de opções seja selecionado.
requireSelectAtMost(number)CheckboxValidationBuilderExigir que no máximo este número de opções seja selecionado.
requireSelectExactly(number)CheckboxValidationBuilderExigir que exatamente este número de opções seja selecionado.

Choice

Métodos

MétodoTipo de retornoBreve descrição
getGotoPage()PageBreakItemRecebe o conjunto PageBreakItem como um destino GO_TO_PAGE se o respondente selecionar essa opção e concluir a página atual.
getPageNavigationType()PageNavigationTypeRecebe o PageNavigationType que ocorre se o usuário selecionar essa opção e concluir a página atual.
getValue()StringRecebe o valor da opção, que os participantes veem como um marcador 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 este item de data.
duplicate()DateItemCria uma cópia deste item e a anexa ao final do formulário.
getGeneralFeedback()QuizFeedback|nullRetorna o feedback mostrado aos participantes quando eles respondem a uma pergunta avaliável.
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()IntegerRecebe o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getPoints()IntegerRetorna o valor de um item avaliável.
getTitle()StringRecebe 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 que será mostrado aos participantes quando eles responderem a uma pergunta avaliável que não tem uma resposta certa ou errada (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 que um item avaliável vale.
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 este item de data e hora.
duplicate()DateTimeItemCria uma cópia deste item e a anexa ao final do formulário.
getGeneralFeedback()QuizFeedback|nullRetorna o feedback mostrado aos participantes quando eles respondem a uma pergunta avaliável.
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()IntegerRecebe o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getPoints()IntegerRetorna o valor de um item avaliável.
getTitle()StringRecebe 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 que será mostrado aos participantes quando eles responderem a uma pergunta avaliável que não tem uma resposta certa ou errada (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 que um item avaliável vale.
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
SPREADSHEETEnumUma planilha 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 este item de data.
duplicate()DurationItemCria uma cópia deste item e a anexa ao final do formulário.
getGeneralFeedback()QuizFeedback|nullRetorna o feedback mostrado aos participantes quando eles respondem a uma pergunta avaliável.
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()IntegerRecebe o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getPoints()IntegerRetorna o valor de um item avaliável.
getTitle()StringRecebe 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 que será mostrado aos participantes quando eles responderem a uma pergunta avaliável que não tem uma resposta certa ou errada (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 que um item avaliável vale.
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 que é mostrado automaticamente aos participantes quando uma pergunta é respondida corretamente.
INCORRECTEnumFeedback que é mostrado automaticamente aos participantes quando uma pergunta é respondida incorretamente.
GENERALEnumO feedback que é mostrado automaticamente aos participantes quando eles enviam a resposta.

Form

Métodos

MétodoTipo de retornoBreve descrição
addCheckboxGridItem()CheckboxGridItemAdiciona um novo item de pergunta, apresentado como uma grade de colunas e linhas, que permite ao participante selecionar várias opções por linha em uma sequência de caixas de seleção.
addCheckboxItem()CheckboxItemAdiciona um novo item de pergunta que permite ao participante selecionar uma ou mais caixas de seleção, além de um campo "Outro" opcional.
addDateItem()DateItemAdiciona um novo item de pergunta que permite ao respondente indicar uma data.
addDateTimeItem()DateTimeItemAdiciona um novo item de pergunta que permite ao respondente indicar uma data e hora.
addDurationItem()DurationItemAdiciona um novo item de pergunta que permite ao respondente indicar um período.
addEditor(emailAddress)FormAdiciona o usuário especificado à lista de editores do Form.
addEditor(user)FormAdiciona o usuário especificado à lista de editores do Form.
addEditors(emailAddresses)FormAdiciona a matriz de usuários à lista de editores do Form.
addGridItem()GridItemAdiciona um novo item de pergunta, apresentado como uma grade de colunas e linhas, que permite ao participante selecionar uma opção por linha em uma sequência de botões de opção.
addImageItem()ImageItemAdiciona um novo item de layout que mostra uma imagem.
addListItem()ListItemAdiciona um novo item de pergunta que permite ao respondente selecionar uma opção em uma lista suspensa.
addMultipleChoiceItem()MultipleChoiceItemAdiciona um novo item de pergunta que permite ao respondente selecionar uma opção em uma lista de botões de opção ou um campo "outro" opcional.
addPageBreakItem()PageBreakItemAdiciona um novo item de layout que marca o início de uma página.
addParagraphTextItem()ParagraphTextItemAdiciona um novo item de pergunta que permite ao respondente inserir um bloco de texto.
addPublishedReader(emailAddress)FormAdiciona o usuário especificado à lista de respondentes do Form.
addPublishedReader(user)FormAdiciona o usuário especificado à lista de respondentes do Form.
addPublishedReaders(emailAddresses)FormAdiciona a matriz de usuários à lista de respondentes do Form.
addRatingItem()RatingItemAdiciona um novo item de pergunta que permite ao entrevistado dar uma classificação.
addScaleItem()ScaleItemAdiciona 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()SectionHeaderItemAdiciona um novo item de layout que indica visualmente o início de uma seção.
addTextItem()TextItemAdiciona um novo item de pergunta que permite ao entrevistado inserir uma única linha de texto.
addTimeItem()TimeItemAdiciona um novo item de pergunta que permite ao participante indicar um horário do dia.
addVideoItem()VideoItemAdiciona um novo item de layout que mostra um vídeo.
canEditResponse()BooleanDetermina se o formulário mostra um link para editar uma resposta depois do 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 do formulário.
deleteItem(item)voidExclui o item especificado.
deleteResponse(responseId)FormExclui uma única resposta do repositório 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()StringRecebe a descrição do formulário.
getDestinationId()StringRecebe o ID do destino da resposta do formulário.
getDestinationType()DestinationTypeRecebe o tipo de destino de resposta do formulário.
getEditUrl()StringRecebe o URL que pode ser usado para acessar o modo de edição do formulário.
getEditors()User[]Recebe a lista de editores para este Form.
getId()StringRecebe o ID do formulário.
getItemById(id)ItemRecebe 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.
getPublishedReaders()User[]Recebe a lista de participantes deste Form.
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 com todas as respostas do formulário.
getResponses(timestamp)FormResponse[]Recebe uma matriz de todas as respostas do formulário após uma determinada data e hora.
getShuffleQuestions()BooleanDetermina se a ordem das perguntas em cada página do formulário é aleatória.
getSummaryUrl()StringRecebe o URL que pode ser usado para ver 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 mostra uma barra de progresso.
hasRespondAgainLink()BooleanDetermina se o formulário mostra um link para enviar outra resposta depois que um participante conclui o formulário.
isAcceptingResponses()BooleanDetermina se o formulário está aceitando respostas no momento.
isPublished()BooleanDetermina se o formulário foi publicado.
isPublishingSummary()BooleanDetermina se o formulário mostra um link para ver um resumo das respostas depois que um participante conclui 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 índice especificado.
moveItem(item, toIndex)ItemMove um item específico para um índice específico 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.
removePublishedReader(emailAddress)FormRemove o usuário especificado da lista de pessoas que responderam ao Form.
removePublishedReader(user)FormRemove o usuário especificado da lista de pessoas que responderam ao Form.
setAcceptingResponses(enabled)FormDefine se o formulário está aceitando respostas no momento.
setAllowResponseEdits(enabled)FormDefine se o formulário mostra um link para editar uma resposta depois do 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 ao 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.
setPublished(enabled)FormDefine se o formulário está publicado.
setPublishingSummary(enabled)FormDefine se o formulário mostra um link para ver um resumo das respostas depois que um participante envia o formulário.
setShowLinkToRespondAgain(enabled)FormDefine se o formulário mostra um link para enviar outra resposta depois que um participante conclui 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 as FormResponses especificadas.
supportsAdvancedResponderPermissions()BooleanDetermina se o formulário pode ser publicado.

FormApp

Propriedades

PropriedadeTipoDescrição
AlignmentAlignmentUma enumeração de tipos de alinhamento de imagens.
DestinationTypeDestinationTypeUma enumeração de tipos de destinos que podem armazenar respostas do formulário.
FeedbackTypeFeedbackTypeUma enumeração de tipos de formulário Feedbacks.
ItemTypeItemTypeUma enumeração de tipos de formulário Items.
PageNavigationTypePageNavigationTypeUma enumeração de possíveis comportamentos para navegar pelas páginas.
RatingIconTypeRatingIconTypeUma enumeração de tipos de ícones de classificação RatingIcons

Métodos

MétodoTipo de retornoBreve descrição
create(title)FormCria e retorna um novo Form.
create(title, isPublished)FormCria e retorna um novo Form no estado de publicação solicitado.
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 usada para definir feedback em um Item avaliável.
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 um TextValidationBuilder que pode ser usado para definir a validação em um TextItem.
getActiveForm()FormRetorna o formulário ao qual o script está vinculado ao contêiner.
getUi()UiRetorna uma instância do ambiente da interface do usuário do editor de formulários que permite ao script adicionar recursos como menus, caixas de diálogo e barras laterais.
openById(id)FormRetorna o Form com o ID especificado.
openByUrl(url)FormRetorna o 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 já enviada.
getGradableItemResponses()ItemResponse[]Recebe todas as respostas de itens contidas em uma resposta do formulário, na mesma ordem em que os itens aparecem no formulário.
getGradableResponseForItem(item)ItemResponseRecebe a resposta do item contida em uma resposta do formulário para um determinado item.
getId()String|nullRecebe o ID da resposta do formulário.
getItemResponses()ItemResponse[]Recebe todas as respostas de itens contidas em uma resposta do 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)ItemResponseRecebe a resposta do item contida nesta resposta do 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 desta resposta do formulário.
withItemGrade(gradedResponse)FormResponseAdiciona as notas da resposta do item especificado a uma resposta do formulário.
withItemResponse(response)FormResponseAdiciona a resposta do item especificado a uma resposta do formulário.

GridItem

Métodos

MétodoTipo de retornoBreve descrição
clearValidation()GridItemRemove qualquer validação de dados do item de grade.
createResponse(responses)ItemResponseCria um novo ItemResponse para este item de grade.
duplicate()GridItemCria uma cópia deste item e a anexa ao final do formulário.
getColumns()String[]Recebe os valores de todas as colunas 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()IntegerRecebe o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getRows()String[]Recebe os valores de cada linha na grade.
getTitle()StringRecebe 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 o limite de uma resposta por coluna para um item de grade.

ImageItem

Métodos

MétodoTipo de retornoBreve descrição
duplicate()ImageItemCria uma cópia deste item e a anexa ao final do formulário.
getAlignment()AlignmentRecebe 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()IntegerRecebe o identificador exclusivo do item.
getImage()BlobRecebe a imagem atribuída ao item no momento.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getTitle()StringRecebe 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()IntegerRecebe 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 de caixa de seleção.
asCheckboxItem()CheckboxItemRetorna o item como uma 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 de grade.
asImageItem()ImageItemRetorna o item como um item de imagem.
asListItem()ListItemRetorna o item como um item de 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.
asRatingItem()RatingItemRetorna o item como um item de classificação.
asScaleItem()ScaleItemRetorna o item como um item de escala.
asSectionHeaderItem()SectionHeaderItemRetorna o item como um item de cabeçalho de 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 a anexa 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()IntegerRecebe o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getTitle()StringRecebe 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 dado para a resposta enviada pelo participante.
getItem()ItemRecebe o item de pergunta que esta resposta responde.
getResponse()ObjectRecebe a resposta enviada pelo participante.
getScore()ObjectRecebe a pontuação da resposta enviada pelo participante.
setFeedback(feedback)ItemResponseDefine o feedback que deve ser mostrado para a resposta enviada pelo participante.
setScore(score)ItemResponseDefine a pontuação da resposta enviada pelo participante.

ItemType

Propriedades

PropriedadeTipoDescrição
CHECKBOXEnumUm item de pergunta que permite ao participante selecionar uma ou mais caixas de seleção, além de um campo "outro" opcional.
CHECKBOX_GRIDEnumUm item de pergunta, apresentado como uma grade de colunas e linhas, que permite ao participante selecionar várias opções por linha em uma sequência de caixas de seleção.
DATEEnumUm item de pergunta que permite ao respondente indicar uma data.
DATETIMEEnumUma questão que permite ao participante indicar uma data e hora.
DURATIONEnumUm item de pergunta que permite ao entrevistado indicar um período.
GRIDEnumUm item de pergunta, apresentado como uma grade de colunas e linhas, que permite ao participante selecionar uma opção por linha em uma sequência de botões de opção.
IMAGEEnumUm item de layout que mostra uma imagem.
LISTEnumUma pergunta que permite ao participante selecionar uma opção em uma lista suspensa.
MULTIPLE_CHOICEEnumUma pergunta que permite ao participante selecionar uma opção em uma lista de botões de opção ou um campo "Outro" opcional.
PAGE_BREAKEnumUm item de layout que marca o início de uma página.
PARAGRAPH_TEXTEnumUm item de pergunta que permite que o entrevistado insira um bloco de texto.
RATINGEnumUma pergunta que permite ao participante dar uma classificação.
SCALEEnumUm item de pergunta que permite que o participante escolha 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.
TEXTEnumUm item de pergunta que permite ao respondente inserir uma única linha de texto.
TIMEEnumUma pergunta que permite ao participante indicar um horário do dia.
VIDEOEnumUm item de layout que mostra um vídeo do YouTube.
FILE_UPLOADEnumUm item de pergunta que permite que o participante faça upload de um arquivo.
UNSUPPORTEDEnumUm item que não é compatível com as APIs no momento.

ListItem

Métodos

MétodoTipo de retornoBreve descrição
createChoice(value)ChoiceCria uma nova opção.
createChoice(value, isCorrect)ChoiceCria uma nova opção.
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 de página.
createResponse(response)ItemResponseCria um novo ItemResponse para este item da lista.
duplicate()ListItemCria uma cópia deste item e a anexa ao final do formulário.
getChoices()Choice[]Recebe todas as opções de um item.
getFeedbackForCorrect()QuizFeedback|nullRetorna o feedback mostrado aos participantes quando eles respondem corretamente a uma pergunta.
getFeedbackForIncorrect()QuizFeedback|nullRetorna o feedback mostrado 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()IntegerRecebe o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getPoints()IntegerRetorna o valor de um item avaliável.
getTitle()StringRecebe 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 de um item em uma matriz de strings.
setChoices(choices)ListItemDefine uma matriz de opções para um item.
setFeedbackForCorrect(feedback)ListItemDefine o feedback que será mostrado aos participantes quando eles responderem corretamente a uma pergunta.
setFeedbackForIncorrect(feedback)ListItemDefine o feedback que 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 que um item avaliável vale.
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 opção.
createChoice(value, isCorrect)ChoiceCria uma nova opção.
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 de página.
createResponse(response)ItemResponseCria um novo ItemResponse para esse item de múltipla escolha.
duplicate()MultipleChoiceItemCria uma cópia deste item e a anexa ao final do formulário.
getChoices()Choice[]Recebe todas as opções de um item.
getFeedbackForCorrect()QuizFeedback|nullRetorna o feedback mostrado aos participantes quando eles respondem corretamente a uma pergunta.
getFeedbackForIncorrect()QuizFeedback|nullRetorna o feedback mostrado 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()IntegerRecebe o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getPoints()IntegerRetorna o valor de um item avaliável.
getTitle()StringRecebe 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 "Outros".
isRequired()BooleanDetermina se o participante precisa responder à pergunta.
setChoiceValues(values)MultipleChoiceItemDefine as opções de um item em uma matriz de strings.
setChoices(choices)MultipleChoiceItemDefine uma matriz de opções para um item.
setFeedbackForCorrect(feedback)MultipleChoiceItemDefine o feedback que será mostrado aos participantes quando eles responderem corretamente a uma pergunta.
setFeedbackForIncorrect(feedback)MultipleChoiceItemDefine o feedback que 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 que um item avaliável vale.
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 "Outros".

PageBreakItem

Métodos

MétodoTipo de retornoBreve descrição
duplicate()PageBreakItemCria uma cópia deste item e a anexa ao final do formulário.
getGoToPage()PageBreakItemRecebe o PageBreakItem para que o formulário pule depois de concluir a página antes desta quebra de página (ou seja, ao atingir 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()IntegerRecebe o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getPageNavigationType()PageNavigationTypeRecebe o tipo de navegação de página que ocorre depois de concluir a página antes desta quebra de página (ou seja, ao alcançar essa quebra de página por progressão linear normal no formulário).
getTitle()StringRecebe 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 a página para a qual pular após concluir a página anterior à quebra de página (ou seja, ao atingir essa quebra de página por progressão linear normal no formulário).
setGoToPage(navigationType)PageBreakItemDefine o tipo de navegação de página que ocorre depois de concluir a página antes dessa quebra de página (ou seja, ao alcançar essa quebra de página por progressão linear normal no 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
CONTINUEEnumContinue para a próxima página do formulário depois de concluir a atual.
GO_TO_PAGEEnumAcessar uma página específica do formulário depois de concluir a página atual.
RESTARTEnumReinicie o formulário do início, sem limpar as respostas inseridas até agora, depois de concluir a página atual.
SUBMITEnumEnvie a resposta do formulário depois de concluir a página atual.

ParagraphTextItem

Métodos

MétodoTipo de retornoBreve descrição
clearValidation()ParagraphTextItemRemove qualquer validação de dados do item de texto do parágrafo.
createResponse(response)ItemResponseCria um novo ItemResponse para este item de texto de parágrafo.
duplicate()ParagraphTextItemCria uma cópia deste item e a anexa ao final do formulário.
getGeneralFeedback()QuizFeedback|nullRetorna o feedback mostrado aos participantes quando eles respondem a uma pergunta avaliável.
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()IntegerRecebe o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getPoints()IntegerRetorna o valor de um item avaliável.
getTitle()StringRecebe 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 que será mostrado aos participantes quando eles responderem a uma pergunta avaliável que não tem uma resposta certa ou errada (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 que um item avaliável vale.
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 este item de texto do parágrafo.

ParagraphTextValidation

ParagraphTextValidationBuilder

Métodos

MétodoTipo de retornoBreve descrição
requireTextContainsPattern(pattern)ParagraphTextValidationBuilderExige que a resposta contenha um padrão.
requireTextDoesNotContainPattern(pattern)ParagraphTextValidationBuilderExige que a resposta não contenha o padrão.
requireTextDoesNotMatchPattern(pattern)ParagraphTextValidationBuilderExige que a resposta não corresponda ao padrão.
requireTextLengthGreaterThanOrEqualTo(number)ParagraphTextValidationBuilderExige que o comprimento da resposta seja maior ou igual ao valor.
requireTextLengthLessThanOrEqualTo(number)ParagraphTextValidationBuilderExige que o comprimento da resposta seja menor que o valor.
requireTextMatchesPattern(pattern)ParagraphTextValidationBuilderExige que a resposta corresponda ao padrão.

QuizFeedback

Métodos

MétodoTipo de retornoBreve descrição
getLinkUrls()String[]Recebe uma lista dos URLs associados ao feedback.
getText()StringRecebe 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 este criador.
copy()QuizFeedbackBuilderRetorna uma cópia deste builder.
setText(text)QuizFeedbackBuilderDefine o texto do feedback.

RatingIconType

Propriedades

PropriedadeTipoDescrição
STAREnumUm ícone de estrela.
HEARTEnumUm ícone de coração.
THUMB_UPEnumUm ícone de positivo.

RatingItem

Métodos

MétodoTipo de retornoBreve descrição
createResponse(response)ItemResponseCria um novo ItemResponse para este item de classificação.
duplicate()RatingItemCria uma cópia deste item e a anexa ao final do formulário.
getGeneralFeedback()QuizFeedback|nullRetorna o feedback mostrado aos participantes quando eles respondem a uma pergunta avaliável.
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()IntegerRecebe o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getPoints()IntegerRetorna o valor de um item avaliável.
getRatingIcon()RatingIconTypeRecebe o ícone escolhido para a classificação.
getRatingScaleLevel()IntegerRecebe o nível da escala da classificação.
getTitle()StringRecebe 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)RatingItemDefine o feedback que será mostrado aos participantes quando eles responderem a uma pergunta avaliável que não tem uma resposta certa ou errada (ou seja, perguntas que exigem avaliação manual).
setHelpText(text)RatingItemDefine 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)RatingItemDefine o número de pontos que um item avaliável vale.
setRatingIcon(ratingIcon)RatingItemDefine o ícone da classificação.
setRatingScaleLevel(ratingScaleLevel)RatingItemDefine o nível máximo da escala de classificação.
setRequired(enabled)RatingItemDefine se o participante precisa responder à pergunta.
setTitle(title)RatingItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).

ScaleItem

Métodos

MétodoTipo de retornoBreve descrição
createResponse(response)ItemResponseCria um novo ItemResponse para este item de escala.
duplicate()ScaleItemCria uma cópia deste item e a anexa ao final do formulário.
getGeneralFeedback()QuizFeedback|nullRetorna o feedback mostrado aos participantes quando eles respondem a uma pergunta avaliável.
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()IntegerRecebe o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getLeftLabel()StringRecebe o marcador do limite inferior da escala, se houver.
getLowerBound()IntegerRecebe o limite inferior da escala.
getPoints()IntegerRetorna o valor de um item avaliável.
getRightLabel()StringRecebe o rótulo do limite superior da escala, se houver.
getTitle()StringRecebe 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 que será mostrado aos participantes quando eles responderem a uma pergunta avaliável que não tem uma resposta certa ou errada (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 que um item avaliável vale.
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 a anexa 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()IntegerRecebe o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getTitle()StringRecebe 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 do item de texto.
createResponse(response)ItemResponseCria um novo ItemResponse para este item de texto.
duplicate()TextItemCria uma cópia deste item e a anexa ao final do formulário.
getGeneralFeedback()QuizFeedback|nullRetorna o feedback mostrado aos participantes quando eles respondem a uma pergunta avaliável.
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()IntegerRecebe o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getPoints()IntegerRetorna o valor de um item avaliável.
getTitle()StringRecebe 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 que será mostrado aos participantes quando eles responderem a uma pergunta avaliável que não tem uma resposta certa ou errada (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 que um item avaliável vale.
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 que a resposta contenha um padrão.
requireTextDoesNotContainPattern(pattern)TextValidationBuilderExige que a resposta não contenha o padrão.
requireTextDoesNotMatchPattern(pattern)TextValidationBuilderExige que a resposta não corresponda ao padrão.
requireTextIsEmail()TextValidationBuilderExige que o item de texto seja um endereço de e-mail.
requireTextIsUrl()TextValidationBuilderExige que o item de texto seja um URL.
requireTextLengthGreaterThanOrEqualTo(number)TextValidationBuilderExige que o comprimento da resposta seja maior ou igual ao valor.
requireTextLengthLessThanOrEqualTo(number)TextValidationBuilderExige que o comprimento da resposta seja menor que o valor.
requireTextMatchesPattern(pattern)TextValidationBuilderExige que a resposta corresponda 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 a anexa ao final do formulário.
getGeneralFeedback()QuizFeedback|nullRetorna o feedback mostrado aos participantes quando eles respondem a uma pergunta avaliável.
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()IntegerRecebe o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getPoints()IntegerRetorna o valor de um item avaliável.
getTitle()StringRecebe 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 que será mostrado aos participantes quando eles responderem a uma pergunta avaliável que não tem uma resposta certa ou errada (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 que um item avaliável vale.
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 a anexa ao final do formulário.
getAlignment()AlignmentRecebe 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()IntegerRecebe o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getTitle()StringRecebe 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()IntegerRecebe 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 vídeo usando um URL ou ID do vídeo do YouTube.
setWidth(width)VideoItemDefine a largura do vídeo em pixels.