Forms Service

Formulários

Este serviço permite que os scripts criem, acessem e modifiquem os Formulários 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 com suporte de alinhamento de imagem.
CheckboxGridItemUm item de pergunta, apresentado como uma grade de colunas e linhas, que permite ao entrevistado 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 respondente 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 que oferece suporte a opções, como CheckboxItem, ListItem ou MultipleChoiceItem.
DateItemUm item de pergunta que permite ao respondente indicar uma data.
DateTimeItemUm item de pergunta que permite ao respondente indicar uma data e hora.
DestinationTypeUm enum que representa os tipos compatíveis de destinos de resposta de formulário.
DurationItemUm item de pergunta que permite que o respondente indique um período de tempo.
FeedbackTypeUm enum que representa os tipos de feedback com suporte.
FormUm formulário que contém itens e propriedades gerais.
FormAppPermite que um script abra uma Form existente ou crie uma nova.
FormResponseUma resposta ao formulário como um todo.
GridItemUm item de pergunta, apresentado como uma grade de colunas e linhas, que permite ao entrevistado selecionar uma opção por linha entre 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 ao entrevistado selecionar uma opção em uma lista suspensa.
MultipleChoiceItemUm item de pergunta que permite ao entrevistado selecionar 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.
ParagraphTextItemUm item de pergunta que permite ao respondente inserir um bloco de texto.
ParagraphTextValidationUm DataValidation para um ParagraphTextItem.
ParagraphTextValidationBuilderUm DataValidationBuilder para um ParagraphTextValidation.
QuizFeedbackA implementação bean de um feedback, que contém propriedades comuns a todos os feedbacks, como texto ou links de exibição.
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 ao entrevistado escolher uma opção de 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 que o participante insira uma única linha de texto.
TextValidationUm DataValidation para um TextItem.
TextValidationBuilderUm DataValidationBuilder para um TextValidation.
TimeItemUm item de pergunta que permite ao respondente indicar uma hora do dia.
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 de grade.
createResponse(responses)ItemResponseCria um novo ItemResponse para esse item de grade da caixa de seleção.
duplicate()CheckboxGridItemCria uma cópia desse item e a anexa ao final do formulário.
getColumns()String[]Recebe os valores de cada coluna da 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 da 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 entrevistado deve 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 respondente 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()CheckboxGridValidationBuilderRequer o limite de uma resposta por coluna para um item de grade.

CheckboxItem

Métodos

MétodoTipo de retornoBreve descrição
clearValidation()CheckboxItemRemove todas as validações de dados deste item da 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 esse item da caixa de seleção.
duplicate()CheckboxItemCria uma cópia desse item e a anexa ao final do formulário.
getChoices()Choice[]Mostra todas as opções de um item.
getFeedbackForCorrect()QuizFeedbackRetorna o feedback que é exibido aos entrevistados quando eles respondem corretamente a uma pergunta.
getFeedbackForIncorrect()QuizFeedbackRetorna o feedback que é exibido aos entrevistados 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 a pontuação de um item com nota.
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 "outro".
isRequired()BooleanDetermina se o entrevistado deve 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á mostrado aos entrevistados quando eles responderem corretamente a uma pergunta.
setFeedbackForIncorrect(feedback)CheckboxItemDefine o feedback a ser mostrado aos entrevistados 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 para um item classificável.
setRequired(enabled)CheckboxItemDefine se o respondente 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)CheckboxValidationBuilderÉ preciso selecionar pelo menos esse número de opções.
requireSelectAtMost(number)CheckboxValidationBuilderExige no máximo esse número de opções para ser selecionada.
requireSelectExactly(number)CheckboxValidationBuilderÉ preciso selecionar exatamente esse número de opções.

Choice

Métodos

MétodoTipo de retornoBreve descrição
getGotoPage()PageBreakItemRecebe o PageBreakItem definido como um destino GO_TO_PAGE se a pessoa que responde selecionar essa opção e concluir a página atual.
getPageNavigationType()PageNavigationTypeRecebe a PageNavigationType que ocorre se o respondente selecionar essa opção e completar a página atual.
getValue()StringRecebe o valor da escolha, que os entrevistados veem como um rótulo ao visualizar o formulário.
isCorrectAnswer()BooleanDescobre se a escolha é 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 desse item e a anexa ao final do formulário.
getGeneralFeedback()QuizFeedbackRetorna o feedback que é exibido aos participantes quando eles respondem a uma pergunta que pode ser classificada.
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 a pontuação de um item com nota.
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 entrevistado deve responder à pergunta.
setGeneralFeedback(feedback)DateItemDefine o feedback que será mostrado aos participantes quando eles responderem a uma pergunta que pode ser avaliada sem uma resposta correta ou incorreta (por exemplo, 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 para um item classificável.
setRequired(enabled)DateItemDefine se o respondente 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 desse item e a anexa ao final do formulário.
getGeneralFeedback()QuizFeedbackRetorna o feedback que é exibido aos participantes quando eles respondem a uma pergunta que pode ser classificada.
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 a pontuação de um item com nota.
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 entrevistado deve responder à pergunta.
setGeneralFeedback(feedback)DateTimeItemDefine o feedback que será mostrado aos participantes quando eles responderem a uma pergunta que pode ser avaliada sem uma resposta correta ou incorreta (por exemplo, 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 para um item classificável.
setRequired(enabled)DateTimeItemDefine se o respondente 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 para respostas de formulários.

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 desse item e a anexa ao final do formulário.
getGeneralFeedback()QuizFeedbackRetorna o feedback que é exibido aos participantes quando eles respondem a uma pergunta que pode ser classificada.
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 a pontuação de um item com nota.
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 entrevistado deve responder à pergunta.
setGeneralFeedback(feedback)DurationItemDefine o feedback que será mostrado aos participantes quando eles responderem a uma pergunta que pode ser avaliada sem uma resposta correta ou incorreta (por exemplo, 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 para um item classificável.
setRequired(enabled)DurationItemDefine se o respondente 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 mostrado automaticamente aos participantes quando eles enviam a resposta.

Form

Métodos

MétodoTipo de retornoBreve descrição
addCheckboxGridItem()CheckboxGridItemAnexa um novo item da 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()CheckboxItemAnexa um novo item de pergunta que permite ao respondente marcar uma ou mais caixas de seleção, bem como um campo "outro" opcional.
addDateItem()DateItemAnexa um novo item da pergunta que permite ao respondente indicar uma data.
addDateTimeItem()DateTimeItemAnexa um novo item da pergunta que permite ao respondente indicar uma data e hora.
addDurationItem()DurationItemAnexa um novo item da pergunta que permite que o respondente indique um período de tempo.
addEditor(emailAddress)FormAdiciona o usuário especificado à lista de editores do Form.
addEditor(user)FormAdiciona o usuário especificado à lista de editores do Form.
addEditors(emailAddresses)FormAdiciona a matriz de usuários especificada à lista de editores do Form.
addGridItem()GridItemAnexa um novo item de pergunta, apresentado como uma grade de colunas e linhas, que permite ao participante selecionar uma opção por linha em uma sequência de botões de opção.
addImageItem()ImageItemAnexa um novo item de layout que exibe uma imagem.
addListItem()ListItemAnexa um novo item de pergunta que permite ao respondente 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 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.
addScaleItem()ScaleItemAnexa um novo item de pergunta que permite ao participante escolher uma opção entre 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 ao respondente inserir uma única linha de texto.
addTimeItem()TimeItemAnexa um novo item de pergunta que permite ao respondente indicar uma hora do dia.
addVideoItem()VideoItemAnexa um novo item de layout que exibe um vídeo.
canEditResponse()BooleanDetermina se o formulário exibirá um link para editar uma resposta depois de enviá-la.
collectsEmail()BooleanDetermina se o formulário coleta os endereços de e-mail dos entrevistados.
createResponse()FormResponseCria uma nova resposta para o formulário.
deleteAllResponses()FormExclui todas as respostas enviadas do armazenamento de respostas do formulário.
deleteItem(index)voidExclui o item com 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()StringExtrai a descrição do formulário.
getDestinationId()StringRecebe o ID do destino da resposta do formulário.
getDestinationType()DestinationTypeExtrai o tipo do destino da resposta do formulário.
getEditUrl()StringExtrai o URL que pode ser usado para acessar o modo de edição do formulário.
getEditors()User[]Recebe a lista de editores deste 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 do formulário.
getItems(itemType)Item[]Recebe uma matriz de todos os itens de um determinado tipo.
getPublishedUrl()StringExtrai 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()StringExtrai o URL que pode ser usado para exibir um resumo das respostas do formulário.
getTitle()StringRecebe o título do formulário.
hasLimitOneResponsePerUser()BooleanDetermina se o formulário permite apenas uma resposta por participante.
hasProgressBar()BooleanDetermina se o formulário exibe uma barra de progresso.
hasRespondAgainLink()BooleanDetermina se o formulário exibe um link para enviar outra resposta depois que um respondente preenche o formulário.
isAcceptingResponses()BooleanDetermina se o formulário está aceitando respostas no momento.
isPublishingSummary()BooleanDetermina se o formulário exibe um link para visualizar um resumo das respostas depois que um respondente preenche o formulário.
isQuiz()BooleanDetermina se o formulário é um teste.
moveItem(from, to)ItemMove um item com determinado índice entre todos os itens do formulário para outro índice.
moveItem(item, toIndex)ItemMove um determinado item para um determinado índice entre todos os itens do formulário.
removeDestination()FormDesvincula o formulário do destino da 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 antes de 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 depois de enviá-la.
setCollectEmail(collect)FormDefine se o formulário coleta os endereços de e-mail dos entrevistados.
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 um respondente 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 depois que um respondente 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 os FormResponses fornecidos.

FormApp

Propriedades

PropriedadeTipoDescrição
AlignmentAlignmentUma enumeração de tipos de alinhamento de imagem.
DestinationTypeDestinationTypeUma enumeração de tipos de destinos que podem armazenar respostas de formulário.
FeedbackTypeFeedbackTypeUma enumeração de tipos de formulário Feedbacks.
ItemTypeItemTypeUma enumeração de tipos de formulário Items.
PageNavigationTypePageNavigationTypeUma enumeração dos possíveis comportamentos de 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 usada 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 o feedback sobre um Item avaliado.
createGridValidation()GridValidationBuilderRetorna uma instância de um GridValidationBuilder que pode ser usada 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 é vinculado ao contêiner.
getUi()UiRetorna uma instância do ambiente de 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 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 de formulário, na mesma ordem em que os itens aparecem no formulário.
getGradableResponseForItem(item)ItemResponseRecebe a resposta do item contida em uma resposta de formulário para um determinado item.
getId()StringRecebe o ID da resposta do formulário.
getItemResponses()ItemResponse[]Recebe todas as respostas de itens contidas em uma resposta de formulário, na mesma ordem em que os itens aparecem no formulário.
getRespondentEmail()StringExtrai 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 contida nesta resposta de formulário para um determinado item.
getTimestamp()DateRecebe o carimbo de data/hora do envio de uma resposta de formulário.
submit()FormResponseEnvia a resposta.
toPrefilledUrl()StringGera um URL para o formulário em que as respostas são pré-preenchidas com base nas respostas desta resposta de formulário.
withItemGrade(gradedResponse)FormResponseAdiciona as notas da resposta do item fornecido a uma resposta do formulário.
withItemResponse(response)FormResponseAdiciona a resposta do item fornecido a uma resposta de formulário.

GridItem

Métodos

MétodoTipo de retornoBreve descrição
clearValidation()GridItemRemove qualquer validação de dados para este item de grade.
createResponse(responses)ItemResponseCria um novo ItemResponse para este item da grade.
duplicate()GridItemCria uma cópia desse item e a anexa ao final do formulário.
getColumns()String[]Recebe os valores de cada coluna da 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 da 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 entrevistado deve 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 respondente 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()GridValidationBuilderRequer 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 desse 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 atualmente atribuída ao 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 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 da caixa de seleção.
asDateItem()DateItemRetorna o item como um item de data.
asDateTimeItem()DateTimeItemRetorna o item como um item de data-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 da lista.
asMultipleChoiceItem()MultipleChoiceItemRetorna o item como de múltipla escolha.
asPageBreakItem()PageBreakItemRetorna o item como uma 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 de seção.
asTextItem()TextItemRetorna o item como um item de texto.
asTimeItem()TimeItemRetorna o item como um item de hora.
asVideoItem()VideoItemRetorna o item como um item de vídeo.
duplicate()ItemCria uma cópia desse 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 da resposta enviada pelo participante.
getItem()ItemRecebe o item da pergunta que esta resposta responde.
getResponse()ObjectAcessa a resposta que o entrevistado enviou.
getScore()ObjectMostra a pontuação da resposta enviada pelo participante.
setFeedback(feedback)ItemResponseDefine o feedback que precisa ser exibido 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 respondente 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 ao entrevistado 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.
DATETIMEEnumUm item de pergunta que permite ao respondente indicar uma data e hora.
DURATIONEnumUm item de pergunta que permite que o respondente indique um período de tempo.
GRIDEnumUm item de pergunta, apresentado como uma grade de colunas e linhas, que permite ao entrevistado selecionar uma opção por linha entre uma sequência de botões de opção.
IMAGEEnumUm item de layout que exibe uma imagem.
LISTEnumUm item de pergunta que permite ao entrevistado selecionar uma opção em uma lista suspensa.
MULTIPLE_CHOICEEnumUm item de pergunta que permite ao entrevistado selecionar 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_TEXTEnumUm item de pergunta que permite ao respondente inserir um bloco de texto.
SCALEEnumUm item de pergunta que permite ao entrevistado escolher uma opção de 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 que o participante insira uma única linha de texto.
TIMEEnumUm item de pergunta que permite ao respondente indicar uma hora do dia.
VIDEOEnumUm item de layout que exibe um vídeo do YouTube.
FILE_UPLOADEnumUm item de pergunta que permite ao respondente fazer upload de um arquivo.

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 na 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 nas páginas.
createResponse(response)ItemResponseCria um novo ItemResponse para este item da lista.
duplicate()ListItemCria uma cópia desse item e a anexa ao final do formulário.
getChoices()Choice[]Mostra todas as opções de um item.
getFeedbackForCorrect()QuizFeedbackRetorna o feedback que é exibido aos entrevistados quando eles respondem corretamente a uma pergunta.
getFeedbackForIncorrect()QuizFeedbackRetorna o feedback que é exibido aos entrevistados 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 a pontuação de um item com nota.
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 entrevistado deve 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á mostrado aos entrevistados quando eles responderem corretamente a uma pergunta.
setFeedbackForIncorrect(feedback)ListItemDefine o feedback a ser mostrado aos entrevistados 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 para um item classificável.
setRequired(enabled)ListItemDefine se o respondente 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 na 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 nas páginas.
createResponse(response)ItemResponseCria um novo ItemResponse para esse item de múltipla escolha.
duplicate()MultipleChoiceItemCria uma cópia desse item e a anexa ao final do formulário.
getChoices()Choice[]Mostra todas as opções de um item.
getFeedbackForCorrect()QuizFeedbackRetorna o feedback que é exibido aos entrevistados quando eles respondem corretamente a uma pergunta.
getFeedbackForIncorrect()QuizFeedbackRetorna o feedback que é exibido aos entrevistados 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 a pontuação de um item com nota.
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 "outro".
isRequired()BooleanDetermina se o entrevistado deve 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á mostrado aos entrevistados quando eles responderem corretamente a uma pergunta.
setFeedbackForIncorrect(feedback)MultipleChoiceItemDefine o feedback a ser mostrado aos entrevistados 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 para um item classificável.
setRequired(enabled)MultipleChoiceItemDefine se o respondente 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 desse item e a anexa ao final do formulário.
getGoToPage()PageBreakItemRecebe o PageBreakItem para o qual o formulário pulará 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 pelo 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 após a conclusão da página antes da quebra de página, ou seja, ao chegar a essa quebra de página pela progressão linear normal pelo 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 de destino depois de concluí-la antes da quebra de página, ou seja, ao chegar a essa quebra de página por progressão linear normal pelo formulário.
setGoToPage(navigationType)PageBreakItemDefine o tipo de navegação na página que ocorre após a conclusão da página antes da quebra de página, ou seja, ao chegar a essa quebra de página pela 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
CONTINUEEnumContinue para a próxima página do formulário depois de preencher a página atual.
GO_TO_PAGEEnumIr para uma página específica do formulário depois de preencher a página atual.
RESTARTEnumDepois de concluir a página atual, reinicie o formulário sem limpar as respostas inseridas até o momento.
SUBMITEnumEnvie a resposta do formulário após 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 do parágrafo.
duplicate()ParagraphTextItemCria uma cópia desse item e a anexa ao final do formulário.
getGeneralFeedback()QuizFeedbackRetorna o feedback que é exibido aos participantes quando eles respondem a uma pergunta que pode ser classificada.
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 a pontuação de um item com nota.
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 entrevistado deve responder à pergunta.
setGeneralFeedback(feedback)ParagraphTextItemDefine o feedback que será mostrado aos participantes quando eles responderem a uma pergunta que pode ser avaliada sem uma resposta correta ou incorreta (por exemplo, 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 para um item classificável.
setRequired(enabled)ParagraphTextItemDefine se o respondente 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 o padrão.
requireTextDoesNotContainPattern(pattern)ParagraphTextValidationBuilderExige que a resposta não contenha um padrão.
requireTextDoesNotMatchPattern(pattern)ParagraphTextValidationBuilderRequer uma resposta para não corresponder ao padrão.
requireTextLengthGreaterThanOrEqualTo(number)ParagraphTextValidationBuilderExige que o comprimento da resposta seja maior ou igual ao valor.
requireTextLengthLessThanOrEqualTo(number)ParagraphTextValidationBuilderRequer que o tamanho da resposta seja menor que o valor.
requireTextMatchesPattern(pattern)ParagraphTextValidationBuilderRequer resposta para corresponder 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 para o material complementar do feedback.
addLink(url, displayText)QuizFeedbackBuilderAdiciona um link para o material complementar do feedback.
build()QuizFeedbackGera um Feedback do tipo correspondente para esse builder.
copy()QuizFeedbackBuilderRetorna uma cópia desse builder.
setText(text)QuizFeedbackBuilderDefine o texto do feedback.

ScaleItem

Métodos

MétodoTipo de retornoBreve descrição
createResponse(response)ItemResponseCria um novo ItemResponse para este item de balança.
duplicate()ScaleItemCria uma cópia desse item e a anexa ao final do formulário.
getGeneralFeedback()QuizFeedbackRetorna o feedback que é exibido aos participantes quando eles respondem a uma pergunta que pode ser classificada.
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 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 com nota.
getRightLabel()StringRecebe o rótulo para o 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 entrevistado deve 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 que pode ser avaliada sem uma resposta correta ou incorreta (por exemplo, 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 para um item classificável.
setRequired(enabled)ScaleItemDefine se o respondente 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 desse 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 todas as validações de dados deste item de texto.
createResponse(response)ItemResponseCria um novo ItemResponse para esse item de texto.
duplicate()TextItemCria uma cópia desse item e a anexa ao final do formulário.
getGeneralFeedback()QuizFeedbackRetorna o feedback que é exibido aos participantes quando eles respondem a uma pergunta que pode ser classificada.
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 a pontuação de um item com nota.
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 entrevistado deve responder à pergunta.
setGeneralFeedback(feedback)TextItemDefine o feedback que será mostrado aos participantes quando eles responderem a uma pergunta que pode ser avaliada sem uma resposta correta ou incorreta (por exemplo, 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 para um item classificável.
setRequired(enabled)TextItemDefine se o respondente 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()TextValidationBuilderO item de texto precisa ser um número.
requireNumberBetween(start, end)TextValidationBuilderExige que o item de texto seja um número entre o início e o fim.
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.
requireNumberNotEqualTo(number)TextValidationBuilderExige que o item de texto seja um número diferente do valor especificado.
requireTextContainsPattern(pattern)TextValidationBuilderExige que a resposta contenha o padrão.
requireTextDoesNotContainPattern(pattern)TextValidationBuilderExige que a resposta não contenha um padrão.
requireTextDoesNotMatchPattern(pattern)TextValidationBuilderRequer uma resposta para não corresponder ao padrão.
requireTextIsEmail()TextValidationBuilderO item de texto precisa ser um endereço de e-mail.
requireTextIsUrl()TextValidationBuilderRequer que o item de texto seja um URL.
requireTextLengthGreaterThanOrEqualTo(number)TextValidationBuilderExige que o comprimento da resposta seja maior ou igual ao valor.
requireTextLengthLessThanOrEqualTo(number)TextValidationBuilderRequer que o tamanho da resposta seja menor que o valor.
requireTextMatchesPattern(pattern)TextValidationBuilderRequer resposta para corresponder ao padrão.
requireWholeNumber()TextValidationBuilderO item de texto precisa ser um número inteiro.

TimeItem

Métodos

MétodoTipo de retornoBreve descrição
createResponse(hour, minute)ItemResponseCria um novo ItemResponse para este item de horário.
duplicate()TimeItemCria uma cópia desse item e a anexa ao final do formulário.
getGeneralFeedback()QuizFeedbackRetorna o feedback que é exibido aos participantes quando eles respondem a uma pergunta que pode ser classificada.
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 a pontuação de um item com nota.
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 entrevistado deve responder à pergunta.
setGeneralFeedback(feedback)TimeItemDefine o feedback que será mostrado aos participantes quando eles responderem a uma pergunta que pode ser avaliada sem uma resposta correta ou incorreta (por exemplo, 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 para um item classificável.
setRequired(enabled)TimeItemDefine se o respondente 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 desse 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 a partir de um URL ou ID do vídeo do YouTube específico.
setWidth(width)VideoItemDefine a largura do vídeo em pixels.