Forms Service

表单

此服务允许脚本创建、访问和修改 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());

名称简介
Alignment表示支持的图片对齐类型的枚举。
CheckboxGridItem一种问题项,表示为由列和行组成的网格,可让受访者从一系列复选框中选择每行多个选项。
CheckboxGridValidationCheckboxGridItem 的 DataValidation。
CheckboxGridValidationBuilderCheckboxGridValidation 的 DataValidationBuilder。
CheckboxItem一个问题项,允许回复者选择一个或多个复选框,以及可选的“其他”字段。
CheckboxValidationCheckboxItem 的 DataValidation。
CheckboxValidationBuilderCheckboxValidation 的 DataValidationBuilder。
Choice与支持选择(如 CheckboxItemListItemMultipleChoiceItem)的 Item 类型相关联的单个选项。
DateItem可让受访者指明日期的问题项。
DateTimeItem可让受访者指定日期和时间的问题项。
DestinationType表示受支持的表单回复目的地类型的枚举。
DurationItem可让受访者指明时长的问题项。
FeedbackType表示支持的反馈类型的枚举。
Form包含整体属性和项目的表单。
FormApp允许脚本打开现有的 Form 或创建新的 Form
FormResponse对表单的整体回复。
GridItem一种问题项,表示为由列和行组成的网格,可让受访者从一系列单选按钮中每行选择一个选项。
GridValidationGridItem 的 DataValidation。
GridValidationBuilderGridValidation 的 DataValidationBuilder。
ImageItem显示图片的布局项。
Item通用表单项,包含所有项的通用属性,例如标题和帮助文本。
ItemResponse对表单中的一个问题项的回复。
ItemType表示受支持的表单项类型的枚举。
ListItem可让受访者从下拉列表中选择一个选项的问题。
MultipleChoiceItem一个问题项,可让受访者从单选按钮列表或可选的“其他”字段中选择一个选项。
PageBreakItem一种布局项,用于标记页面的开头。
PageNavigationType表示支持的网页导航类型的枚举。
ParagraphTextItem可让受访者输入一段文本的问题项。
ParagraphTextValidationParagraphTextItem 的 DataValidation。
ParagraphTextValidationBuilderParagraphTextValidation 的 DataValidationBuilder。
QuizFeedback反馈的 Bean 实现,其中包含所有反馈通用的属性,例如显示文本或链接。
QuizFeedbackBuilder基本 FeedbackBuilder 包含适用于所有反馈通用属性(例如显示文本)的 setter。
ScaleItem一个问题项,可让受访者从一系列有编号的单选按钮中选择一个选项。
SectionHeaderItem一种布局项,直观地指示部分开始。
TextItem可让受访者输入单行文本的问题项。
TextValidationTextItem 的 DataValidation。
TextValidationBuilderTextValidation 的 DataValidationBuilder。
TimeItem可让受访者指明一天中的时间的问题项。
VideoItem显示视频的布局项。

Alignment

属性

媒体资源类型说明
LEFTEnum将图片与表单左侧对齐。
CENTEREnum将图片对齐表单中心。
RIGHTEnum将图片与表单右侧对齐。

CheckboxGridItem

方法

方法返回类型简介
clearValidation()CheckboxGridItem移除此网格项的所有数据验证。
createResponse(responses)ItemResponse为此复选框网格项创建一个新的 ItemResponse
duplicate()CheckboxGridItem创建此项目的副本,并将其附加到表单的末尾。
getColumns()String[]获取网格中每列的值。
getHelpText()String获取该项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
getId()Integer获取项的唯一标识符。
getIndex()Integer获取表单中所有项中的项的索引。
getRows()String[]获取网格中每一行的值。
getTitle()String获取商品的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
getType()ItemType获取该项的类型,表示为 ItemType
isRequired()Boolean确定受访者是否必须回答问题。
setColumns(columns)CheckboxGridItem根据值数组设置网格的列。
setHelpText(text)CheckboxGridItem设置项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
setRequired(enabled)CheckboxGridItem设置受访者是否必须回答问题。
setRows(rows)CheckboxGridItem根据值数组设置网格的行。
setTitle(title)CheckboxGridItem设置项目的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
setValidation(validation)CheckboxGridItem用于设置此复选框网格项的数据验证。

CheckboxGridValidation

CheckboxGridValidationBuilder

方法

方法返回类型简介
requireLimitOneResponsePerColumn()CheckboxGridValidationBuilder要求针对网格项的每列限一条回复。

CheckboxItem

方法

方法返回类型简介
clearValidation()CheckboxItem移除此复选框项的所有数据验证。
createChoice(value)Choice创建新的选项。
createChoice(value, isCorrect)Choice创建新的选项。
createResponse(responses)ItemResponse为此复选框项创建一个新的 ItemResponse
duplicate()CheckboxItem创建此项目的副本,并将其附加到表单的末尾。
getChoices()Choice[]获取某个项的所有选项。
getFeedbackForCorrect()QuizFeedback返回在回复者正确回答问题后向其显示的反馈。
getFeedbackForIncorrect()QuizFeedback返回在回复者错误地回答问题时显示的反馈。
getHelpText()String获取该项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
getId()Integer获取项的唯一标识符。
getIndex()Integer获取表单中所有项中的项的索引。
getPoints()Integer返回可评分项的分值。
getTitle()String获取商品的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
getType()ItemType获取该项的类型,表示为 ItemType
hasOtherOption()Boolean确定相应项是否有“其他”选项。
isRequired()Boolean确定受访者是否必须回答问题。
setChoiceValues(values)CheckboxItem设置字符串数组中的项的选项。
setChoices(choices)CheckboxItem为项设置一组选项。
setFeedbackForCorrect(feedback)CheckboxItem设置在回复者正确回答问题后向其显示的反馈。
setFeedbackForIncorrect(feedback)CheckboxItem设置在回复者错误回答问题时向其显示的反馈。
setHelpText(text)CheckboxItem设置项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
setPoints(points)CheckboxItem设置可评分项目的分值。
setRequired(enabled)CheckboxItem设置受访者是否必须回答问题。
setTitle(title)CheckboxItem设置项目的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
setValidation(validation)CheckboxItem用于设置该复选框项的数据验证。
showOtherOption(enabled)CheckboxItem设置相应项是否有“其他”选项。

CheckboxValidation

CheckboxValidationBuilder

方法

方法返回类型简介
requireSelectAtLeast(number)CheckboxValidationBuilder必须至少选择这么多选项。
requireSelectAtMost(number)CheckboxValidationBuilder最多只能选择这么多选项。
requireSelectExactly(number)CheckboxValidationBuilder必须选择这么多选项。

Choice

方法

方法返回类型简介
getGotoPage()PageBreakItem如果响应者选择此选项并完成当前页面,则获取设置为 GO_TO_PAGE 目的地的 PageBreakItem
getPageNavigationType()PageNavigationType获取响应者选择此选项并完成当前页面时发生的 PageNavigationType
getValue()String获取选项的值,受访者查看表单时看到的是标签。
isCorrectAnswer()Boolean获取所选选项是否为问题的正确答案。

DateItem

方法

方法返回类型简介
createResponse(response)ItemResponse为此日期项创建新的 ItemResponse
duplicate()DateItem创建此项目的副本,并将其附加到表单的末尾。
getGeneralFeedback()QuizFeedback返回回复者在回答可评分的问题后向其显示的反馈。
getHelpText()String获取该项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
getId()Integer获取项的唯一标识符。
getIndex()Integer获取表单中所有项中的项的索引。
getPoints()Integer返回可评分项的分值。
getTitle()String获取商品的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
getType()ItemType获取该项的类型,表示为 ItemType
includesYear()Boolean确定日期项是否包含年份选项。
isRequired()Boolean确定受访者是否必须回答问题。
setGeneralFeedback(feedback)DateItem设置在回复者回答没有正确或错误答案的可评分问题(例如,需要手动评分的问题)时向其显示反馈。
setHelpText(text)DateItem设置项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
setIncludesYear(enableYear)DateItem设置日期项是否包含年份设置。
setPoints(points)DateItem设置可评分项目的分值。
setRequired(enabled)DateItem设置受访者是否必须回答问题。
setTitle(title)DateItem设置项目的标题(如果为 SectionHeaderItem,则有时称为标题文本)。

DateTimeItem

方法

方法返回类型简介
createResponse(response)ItemResponse为此日期时间项创建新的 ItemResponse
duplicate()DateTimeItem创建此项目的副本,并将其附加到表单的末尾。
getGeneralFeedback()QuizFeedback返回回复者在回答可评分的问题后向其显示的反馈。
getHelpText()String获取该项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
getId()Integer获取项的唯一标识符。
getIndex()Integer获取表单中所有项中的项的索引。
getPoints()Integer返回可评分项的分值。
getTitle()String获取商品的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
getType()ItemType获取该项的类型,表示为 ItemType
includesYear()Boolean确定日期项是否包含年份选项。
isRequired()Boolean确定受访者是否必须回答问题。
setGeneralFeedback(feedback)DateTimeItem设置在回复者回答没有正确或错误答案的可评分问题(例如,需要手动评分的问题)时向其显示反馈。
setHelpText(text)DateTimeItem设置项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
setIncludesYear(enableYear)DateTimeItem设置日期项是否包含年份设置。
setPoints(points)DateTimeItem设置可评分项目的分值。
setRequired(enabled)DateTimeItem设置受访者是否必须回答问题。
setTitle(title)DateTimeItem设置项目的标题(如果为 SectionHeaderItem,则有时称为标题文本)。

DestinationType

属性

媒体资源类型说明
SPREADSHEETEnum一个 Google 表格电子表格,用作表单回复的目标位置。

DurationItem

方法

方法返回类型简介
createResponse(hours, minutes, seconds)ItemResponse为此日期项创建新的 ItemResponse
duplicate()DurationItem创建此项目的副本,并将其附加到表单的末尾。
getGeneralFeedback()QuizFeedback返回回复者在回答可评分的问题后向其显示的反馈。
getHelpText()String获取该项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
getId()Integer获取项的唯一标识符。
getIndex()Integer获取表单中所有项中的项的索引。
getPoints()Integer返回可评分项的分值。
getTitle()String获取商品的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
getType()ItemType获取该项的类型,表示为 ItemType
isRequired()Boolean确定受访者是否必须回答问题。
setGeneralFeedback(feedback)DurationItem设置在回复者回答没有正确或错误答案的可评分问题(例如,需要手动评分的问题)时向其显示反馈。
setHelpText(text)DurationItem设置项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
setPoints(points)DurationItem设置可评分项目的分值。
setRequired(enabled)DurationItem设置受访者是否必须回答问题。
setTitle(title)DurationItem设置项目的标题(如果为 SectionHeaderItem,则有时称为标题文本)。

FeedbackType

属性

媒体资源类型说明
CORRECTEnum自动向回复者回答正确问题的反馈。
INCORRECTEnum自动向回复者回答错误的问题显示的反馈。
GENERALEnum在回复者提交回复时自动显示的反馈。

Form

方法

方法返回类型简介
addCheckboxGridItem()CheckboxGridItem附加一个新的问题项,表示为由列和行组成的网格,使回复者能够从一系列复选框中逐行选择多个选项。
addCheckboxItem()CheckboxItem附加新的问题项,使回复者能够选择一个或多个复选框,以及可选的“其他”字段。
addDateItem()DateItem附加新的问题项,以便受访者指定日期。
addDateTimeItem()DateTimeItem附加新的问题项,以便回复者指明日期和时间。
addDurationItem()DurationItem附加新的问题项,以便受访者指明答题时长。
addEditor(emailAddress)Form将指定用户添加到 Form 的编辑者列表中。
addEditor(user)Form将指定用户添加到 Form 的编辑者列表中。
addEditors(emailAddresses)Form将给定的用户数组添加到 Form 的编辑者列表中。
addGridItem()GridItem附加一个新问题项,表示为由列和行组成的网格,使受访者能够在一行中从一系列单选按钮中选择一个选项。
addImageItem()ImageItem用于附加显示图片的新布局项。
addListItem()ListItem附加一个新的问题项,使受访者能够从下拉列表中选择一个选项。
addMultipleChoiceItem()MultipleChoiceItem添加新的问题项,使受访者能够从单选按钮列表或可选的“其他”字段中选择一个选项。
addPageBreakItem()PageBreakItem用于添加新的布局项,用于标记页面的开头。
addParagraphTextItem()ParagraphTextItem添加新的问题项,使回复者能够输入一段文本。
addScaleItem()ScaleItem附加新的问题项,使受访者能够从一系列有编号的单选按钮中选择一个选项。
addSectionHeaderItem()SectionHeaderItem用于附加新的布局项,以视觉方式指示某个部分的开头。
addTextItem()TextItem附加新的问题项,允许回复者输入单行文本。
addTimeItem()TimeItem附加新的问题项,让受访者能够指明一天中的时间。
addVideoItem()VideoItem用于附加显示视频的新布局项。
canEditResponse()Boolean确定表单在提交后是否显示用于修改回复的链接。
collectsEmail()Boolean确定表单是否收集回复者的电子邮件地址。
createResponse()FormResponse创建对表单的新回复。
deleteAllResponses()Form从表单的响应存储区中删除所有已提交的响应。
deleteItem(index)void从表单的所有项中删除位于指定索引处的项。
deleteItem(item)void删除给定项。
deleteResponse(responseId)Form从表单的响应存储区中删除单个回复。
getConfirmationMessage()String获取表单的确认消息。
getCustomClosedFormMessage()String获取在表单不接受响应时显示的自定义消息,或在未设置自定义消息时获取空字符串。
getDescription()String获取表单的说明。
getDestinationId()String获取表单的响应目标的 ID。
getDestinationType()DestinationType获取表单响应目标的类型。
getEditUrl()String获取可用于访问表单编辑模式的网址。
getEditors()User[]获取此 Form 的编辑者列表。
getId()String获取表单的 ID。
getItemById(id)Item获取具有指定 ID 的项。
getItems()Item[]获取表单中所有项的数组。
getItems(itemType)Item[]获取由指定类型的所有项组成的数组。
getPublishedUrl()String获取可用于回复表单的网址。
getResponse(responseId)FormResponse根据回复 ID 获取单个表单回复。
getResponses()FormResponse[]获取表单的所有回复的数组。
getResponses(timestamp)FormResponse[]获取指定日期和时间之后的所有表单回复的数组。
getShuffleQuestions()Boolean确定表单每个页面上的问题顺序是否随机。
getSummaryUrl()String获取可用于查看表单响应摘要的网址。
getTitle()String获取表单的标题。
hasLimitOneResponsePerUser()Boolean确定表单是否只允许每个受访者有一个回复。
hasProgressBar()Boolean确定表单是否显示进度条。
hasRespondAgainLink()Boolean确定在回复者填写表单后表单是否显示用于提交另一份回复的链接。
isAcceptingResponses()Boolean确定表单当前是否接受回复。
isPublishingSummary()Boolean确定在回复者填写表单后表单是否显示用于查看回复摘要的链接。
isQuiz()Boolean确定表单是否为测验。
moveItem(from, to)Item将表单中所有项中位于指定索引处的项移到另一个指定索引处。
moveItem(item, toIndex)Item将给定项移到表单所有项中的指定索引。
removeDestination()Form取消表单与其当前回复目标的关联。
removeEditor(emailAddress)FormForm 的编辑者列表中移除指定用户。
removeEditor(user)FormForm 的编辑者列表中移除指定用户。
requiresLogin()Boolean确定表单是否要求受访者必须登录同一网域或子网域中的帐号才能回复。
setAcceptingResponses(enabled)Form设置表单当前是否接受回复。
setAllowResponseEdits(enabled)Form设置表单在提交后是否显示用于修改回复的链接。
setCollectEmail(collect)Form设置表单是否收集回复者的电子邮件地址。
setConfirmationMessage(message)Form设置表单的确认消息。
setCustomClosedFormMessage(message)Form设置在表单不接受回复时显示的消息。
setDescription(description)Form设置表单的说明。
setDestination(type, id)Form设置保存表单回复的目标位置。
setIsQuiz(enabled)Form设置表单是否为测验。
setLimitOneResponsePerUser(enabled)Form设置表单是否只允许每个回复者发送一条回复。
setProgressBar(enabled)Form设置表单是否有进度条。
setPublishingSummary(enabled)Form设置在回复者提交表单后,表单是否显示用于查看回复摘要的链接。
setRequireLogin(requireLogin)Form设置表单是否要求受访者必须登录同一网域或子网域中的账号才能回复。
setShowLinkToRespondAgain(enabled)Form设置在回复者填好表单后,表单是否显示用于提交另一份回复的链接。
setShuffleQuestions(shuffle)Form设置表单各页面上的问题顺序是否随机。
setTitle(title)Form设置表单的标题。
shortenFormUrl(url)String将表单的长网址转换为短网址。
submitGrades(responses)Form提交指定 FormResponse 的成绩。

FormApp

属性

媒体资源类型说明
AlignmentAlignment枚举各种图片对齐类型。
DestinationTypeDestinationType可存储表单回复的目的地类型的枚举。
FeedbackTypeFeedbackType类型为 Feedbacks 的枚举。
ItemTypeItemType类型为 Items 的枚举。
PageNavigationTypePageNavigationType一个枚举,列出可能在页面导航时的行为。

方法

方法返回类型简介
create(title)Form创建并返回新的 Form
createCheckboxGridValidation()CheckboxGridValidationBuilder返回 CheckboxGridValidationBuilder 的实例,用于对 CheckboxGridItem 设置验证。
createCheckboxValidation()CheckboxValidationBuilder返回 CheckboxValidationBuilder 的实例,用于对 CheckboxItem 设置验证。
createFeedback()QuizFeedbackBuilder返回 QuizFeedbackBuilder 的实例,该实例可用于针对可评分的 Item 设置反馈。
createGridValidation()GridValidationBuilder返回可用于对 GridItem 设置验证的 GridValidationBuilder 实例。
createParagraphTextValidation()ParagraphTextValidationBuilder返回 ParagraphTextValidationBuilder 的实例,该实例可用于对 ParagraphTextItem 设置验证。
createTextValidation()TextValidationBuilder返回 TextValidationBuilder 的实例,该实例可用于对 TextItem 设置验证。
getActiveForm()Form返回脚本与容器绑定的形式。
getUi()Ui返回表单编辑器界面环境的实例,允许脚本添加菜单、对话框和边栏等功能。
openById(id)Form返回具有指定 ID 的 Form
openByUrl(url)Form返回具有指定网址的 Form

FormResponse

方法

方法返回类型简介
getEditResponseUrl()String生成一个网址,可用于修改已提交的回复。
getGradableItemResponses()ItemResponse[]获取表单响应中包含的所有项响应,响应顺序与项在表单中显示的顺序相同。
getGradableResponseForItem(item)ItemResponse获取给定项目的表单响应中包含的项目响应。
getId()String获取表单回复的 ID。
getItemResponses()ItemResponse[]获取表单响应中包含的所有项响应,响应顺序与项在表单中显示的顺序相同。
getRespondentEmail()String如果启用了 Form.setCollectEmail(collect) 设置,则获取提交回复的用户的电子邮件地址。
getResponseForItem(item)ItemResponse获取此表单响应中包含的针对给定项的项响应。
getTimestamp()Date获取表单回复提交的时间戳。
submit()FormResponse提交响应。
toPrefilledUrl()String根据此表单回复中的答案,为表单生成一个网址,在该表单中预填充答案。
withItemGrade(gradedResponse)FormResponse将指定内容回复的成绩添加到表单回复中。
withItemResponse(response)FormResponse将指定项响应添加到表单回复。

GridItem

方法

方法返回类型简介
clearValidation()GridItem移除此网格项的所有数据验证。
createResponse(responses)ItemResponse为此网格项创建一个新的 ItemResponse
duplicate()GridItem创建此项目的副本,并将其附加到表单的末尾。
getColumns()String[]获取网格中每列的值。
getHelpText()String获取该项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
getId()Integer获取项的唯一标识符。
getIndex()Integer获取表单中所有项中的项的索引。
getRows()String[]获取网格中每一行的值。
getTitle()String获取商品的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
getType()ItemType获取该项的类型,表示为 ItemType
isRequired()Boolean确定受访者是否必须回答问题。
setColumns(columns)GridItem根据值数组设置网格的列。
setHelpText(text)GridItem设置项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
setRequired(enabled)GridItem设置受访者是否必须回答问题。
setRows(rows)GridItem根据值数组设置网格的行。
setTitle(title)GridItem设置项目的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
setValidation(validation)GridItem设置此网格项的数据验证。

GridValidation

GridValidationBuilder

方法

方法返回类型简介
requireLimitOneResponsePerColumn()GridValidationBuilder要求针对网格项的每列限一条回复。

ImageItem

方法

方法返回类型简介
duplicate()ImageItem创建此项目的副本,并将其附加到表单的末尾。
getAlignment()Alignment获取图片的水平对齐方式。
getHelpText()String获取该项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
getId()Integer获取项的唯一标识符。
getImage()Blob获取当前分配给该项的图片。
getIndex()Integer获取表单中所有项中的项的索引。
getTitle()String获取商品的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
getType()ItemType获取该项的类型,表示为 ItemType
getWidth()Integer获取图片的宽度(以像素为单位)。
setAlignment(alignment)ImageItem设置图片的水平对齐方式。
setHelpText(text)ImageItem设置项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
setImage(image)ImageItem设置图像本身。
setTitle(title)ImageItem设置项目的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
setWidth(width)ImageItem设置图片的宽度(以像素为单位)。

Item

方法

方法返回类型简介
asCheckboxGridItem()CheckboxGridItem将该项作为复选框网格项返回。
asCheckboxItem()CheckboxItem将项目作为复选框项返回。
asDateItem()DateItem将该项作为日期项返回。
asDateTimeItem()DateTimeItem将该项作为日期时间项返回。
asDurationItem()DurationItem将内容作为时长项返回。
asGridItem()GridItem将该项作为网格项返回。
asImageItem()ImageItem将该项作为图片项返回。
asListItem()ListItem将该项作为列表项返回。
asMultipleChoiceItem()MultipleChoiceItem将该项作为单选题返回。
asPageBreakItem()PageBreakItem将该项作为分页符项返回。
asParagraphTextItem()ParagraphTextItem将该项作为段落文本项返回。
asScaleItem()ScaleItem将该项作为比例项返回。
asSectionHeaderItem()SectionHeaderItem将内容作为版块标题项返回。
asTextItem()TextItem将该项作为文本项返回。
asTimeItem()TimeItem将该项作为时间项返回。
asVideoItem()VideoItem将内容作为视频项返回。
duplicate()Item创建此项目的副本,并将其附加到表单的末尾。
getHelpText()String获取该项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
getId()Integer获取项的唯一标识符。
getIndex()Integer获取表单中所有项中的项的索引。
getTitle()String获取商品的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
getType()ItemType获取该项的类型,表示为 ItemType
setHelpText(text)Item设置项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
setTitle(title)Item设置项目的标题(如果为 SectionHeaderItem,则有时称为标题文本)。

ItemResponse

方法

方法返回类型简介
getFeedback()Object获取针对受访者提交的回答给出的反馈。
getItem()Item获取此响应回答的问题项。
getResponse()Object获取受访者提交的回答。
getScore()Object获取受访者提交的答案的得分。
setFeedback(feedback)ItemResponse设置要针对受访者提交的回答显示的反馈。
setScore(score)ItemResponse为受访者提交的回答设置分数。

ItemType

属性

媒体资源类型说明
CHECKBOXEnum一个问题项,允许回复者选择一个或多个复选框,以及可选的“其他”字段。
CHECKBOX_GRIDEnum一种问题项,表示为由列和行组成的网格,可让受访者从一系列复选框中选择每行多个选项。
DATEEnum可让受访者指明日期的问题项。
DATETIMEEnum可让受访者指定日期和时间的问题项。
DURATIONEnum可让受访者指明时长的问题项。
GRIDEnum一种问题项,表示为由列和行组成的网格,可让受访者从一系列单选按钮中每行选择一个选项。
IMAGEEnum显示图片的布局项。
LISTEnum可让受访者从下拉列表中选择一个选项的问题。
MULTIPLE_CHOICEEnum一个问题项,可让受访者从单选按钮列表或可选的“其他”字段中选择一个选项。
PAGE_BREAKEnum一种布局项,用于标记页面的开头。
PARAGRAPH_TEXTEnum可让受访者输入一段文本的问题项。
SCALEEnum一个问题项,可让受访者从一系列有编号的单选按钮中选择一个选项。
SECTION_HEADEREnum一种布局项,直观地指示部分开始。
TEXTEnum可让受访者输入单行文本的问题项。
TIMEEnum可让受访者指明一天中的时间的问题项。
VIDEOEnum显示 YouTube 视频的布局项。
FILE_UPLOADEnum可让受访者上传文件的问题项。

ListItem

方法

方法返回类型简介
createChoice(value)Choice创建新的选项。
createChoice(value, isCorrect)Choice创建新的选项。
createChoice(value, navigationItem)Choice创建一个新选项,其中包含一个可跳转到给定分页符项的页面导航选项。
createChoice(value, navigationType)Choice创建包含页面导航选项的新选项。
createResponse(response)ItemResponse为此列表项创建一个新的 ItemResponse
duplicate()ListItem创建此项目的副本,并将其附加到表单的末尾。
getChoices()Choice[]获取某个项的所有选项。
getFeedbackForCorrect()QuizFeedback返回在回复者正确回答问题后向其显示的反馈。
getFeedbackForIncorrect()QuizFeedback返回在回复者错误地回答问题时显示的反馈。
getHelpText()String获取该项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
getId()Integer获取项的唯一标识符。
getIndex()Integer获取表单中所有项中的项的索引。
getPoints()Integer返回可评分项的分值。
getTitle()String获取商品的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
getType()ItemType获取该项的类型,表示为 ItemType
isRequired()Boolean确定受访者是否必须回答问题。
setChoiceValues(values)ListItem设置字符串数组中的项的选项。
setChoices(choices)ListItem为项设置一组选项。
setFeedbackForCorrect(feedback)ListItem设置在回复者正确回答问题后向其显示的反馈。
setFeedbackForIncorrect(feedback)ListItem设置在回复者错误回答问题时向其显示的反馈。
setHelpText(text)ListItem设置项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
setPoints(points)ListItem设置可评分项目的分值。
setRequired(enabled)ListItem设置受访者是否必须回答问题。
setTitle(title)ListItem设置项目的标题(如果为 SectionHeaderItem,则有时称为标题文本)。

MultipleChoiceItem

方法

方法返回类型简介
createChoice(value)Choice创建新的选项。
createChoice(value, isCorrect)Choice创建新的选项。
createChoice(value, navigationItem)Choice创建一个新选项,其中包含一个可跳转到给定分页符项的页面导航选项。
createChoice(value, navigationType)Choice创建包含页面导航选项的新选项。
createResponse(response)ItemResponse用于为此单选题创建一个新的 ItemResponse
duplicate()MultipleChoiceItem创建此项目的副本,并将其附加到表单的末尾。
getChoices()Choice[]获取某个项的所有选项。
getFeedbackForCorrect()QuizFeedback返回在回复者正确回答问题后向其显示的反馈。
getFeedbackForIncorrect()QuizFeedback返回在回复者错误地回答问题时显示的反馈。
getHelpText()String获取该项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
getId()Integer获取项的唯一标识符。
getIndex()Integer获取表单中所有项中的项的索引。
getPoints()Integer返回可评分项的分值。
getTitle()String获取商品的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
getType()ItemType获取该项的类型,表示为 ItemType
hasOtherOption()Boolean确定相应项是否有“其他”选项。
isRequired()Boolean确定受访者是否必须回答问题。
setChoiceValues(values)MultipleChoiceItem设置字符串数组中的项的选项。
setChoices(choices)MultipleChoiceItem为项设置一组选项。
setFeedbackForCorrect(feedback)MultipleChoiceItem设置在回复者正确回答问题后向其显示的反馈。
setFeedbackForIncorrect(feedback)MultipleChoiceItem设置在回复者错误回答问题时向其显示的反馈。
setHelpText(text)MultipleChoiceItem设置项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
setPoints(points)MultipleChoiceItem设置可评分项目的分值。
setRequired(enabled)MultipleChoiceItem设置受访者是否必须回答问题。
setTitle(title)MultipleChoiceItem设置项目的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
showOtherOption(enabled)MultipleChoiceItem设置相应项是否有“其他”选项。

PageBreakItem

方法

方法返回类型简介
duplicate()PageBreakItem创建此项目的副本,并将其附加到表单的末尾。
getGoToPage()PageBreakItem获取 PageBreakItem,在分页符之前(即,通过表单正常线性跳转到达此分页符时),表单将跳转到该分页符。
getHelpText()String获取该项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
getId()Integer获取项的唯一标识符。
getIndex()Integer获取表单中所有项中的项的索引。
getPageNavigationType()PageNavigationType获取在分页符之前完成页面后(即通过表单正常线性前进到达此分页符时)的页面导航类型。
getTitle()String获取商品的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
getType()ItemType获取该项的类型,表示为 ItemType
setGoToPage(goToPageItem)PageBreakItem将完成页面后(即,通过表单正常线性跳转到达此分页符时)要跳转到的页面。
setGoToPage(navigationType)PageBreakItem设置在此分页符之前完成页面后(即通过表单正常线性进度到达此分页符时)的页面导航类型。
setHelpText(text)PageBreakItem设置项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
setTitle(title)PageBreakItem设置项目的标题(如果为 SectionHeaderItem,则有时称为标题文本)。

属性

媒体资源类型说明
CONTINUEEnum填写当前页面后继续转到表单的下一页。
GO_TO_PAGEEnum完成当前页面后跳转到表单的指定页面。
RESTARTEnum完成当前页面后,从头开始重启表单,但不要清除到目前为止输入的答案。
SUBMITEnum填写当前页面后提交表单回复。

ParagraphTextItem

方法

方法返回类型简介
clearValidation()ParagraphTextItem删除此段落文本项的任何数据验证。
createResponse(response)ItemResponse为此段落文本项创建一个新的 ItemResponse
duplicate()ParagraphTextItem创建此项目的副本,并将其附加到表单的末尾。
getGeneralFeedback()QuizFeedback返回回复者在回答可评分的问题后向其显示的反馈。
getHelpText()String获取该项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
getId()Integer获取项的唯一标识符。
getIndex()Integer获取表单中所有项中的项的索引。
getPoints()Integer返回可评分项的分值。
getTitle()String获取商品的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
getType()ItemType获取该项的类型,表示为 ItemType
isRequired()Boolean确定受访者是否必须回答问题。
setGeneralFeedback(feedback)ParagraphTextItem设置在回复者回答没有正确或错误答案的可评分问题(例如,需要手动评分的问题)时向其显示反馈。
setHelpText(text)ParagraphTextItem设置项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
setPoints(points)ParagraphTextItem设置可评分项目的分值。
setRequired(enabled)ParagraphTextItem设置受访者是否必须回答问题。
setTitle(title)ParagraphTextItem设置项目的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
setValidation(validation)ParagraphTextItem设置该段落文本项的数据验证。

ParagraphTextValidation

ParagraphTextValidationBuilder

QuizFeedback

方法

方法返回类型简介
getLinkUrls()String[]获取与反馈相关联的网址列表。
getText()String获取反馈的显示文本。

QuizFeedbackBuilder

方法

方法返回类型简介
addLink(url)QuizFeedbackBuilder添加指向反馈补充资料的链接。
addLink(url, displayText)QuizFeedbackBuilder添加指向反馈补充资料的链接。
build()QuizFeedback为此构建器构建相应类型的反馈。
copy()QuizFeedbackBuilder返回此构建器的副本。
setText(text)QuizFeedbackBuilder设置反馈文本。

ScaleItem

方法

方法返回类型简介
createResponse(response)ItemResponse为此体重秤项目创建新的 ItemResponse
duplicate()ScaleItem创建此项目的副本,并将其附加到表单的末尾。
getGeneralFeedback()QuizFeedback返回回复者在回答可评分的问题后向其显示的反馈。
getHelpText()String获取该项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
getId()Integer获取项的唯一标识符。
getIndex()Integer获取表单中所有项中的项的索引。
getLeftLabel()String获取比例下限的标签(如果有)。
getLowerBound()Integer获取体重秤的下限。
getPoints()Integer返回可评分项的分值。
getRightLabel()String获取比例上限的标签(如果有)。
getTitle()String获取商品的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
getType()ItemType获取该项的类型,表示为 ItemType
getUpperBound()Integer获取体重秤的上限。
isRequired()Boolean确定受访者是否必须回答问题。
setBounds(lower, upper)ScaleItem设置比例的下限和上限。
setGeneralFeedback(feedback)ScaleItem设置在回复者回答没有正确或错误答案的可评分问题(例如,需要手动评分的问题)时向其显示反馈。
setHelpText(text)ScaleItem设置项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
setLabels(lower, upper)ScaleItem设置比例下限和上限的标签。
setPoints(points)ScaleItem设置可评分项目的分值。
setRequired(enabled)ScaleItem设置受访者是否必须回答问题。
setTitle(title)ScaleItem设置项目的标题(如果为 SectionHeaderItem,则有时称为标题文本)。

SectionHeaderItem

方法

方法返回类型简介
duplicate()SectionHeaderItem创建此项目的副本,并将其附加到表单的末尾。
getHelpText()String获取该项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
getId()Integer获取项的唯一标识符。
getIndex()Integer获取表单中所有项中的项的索引。
getTitle()String获取商品的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
getType()ItemType获取该项的类型,表示为 ItemType
setHelpText(text)SectionHeaderItem设置项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
setTitle(title)SectionHeaderItem设置项目的标题(如果为 SectionHeaderItem,则有时称为标题文本)。

TextItem

方法

方法返回类型简介
clearValidation()TextItem移除此文本项的所有数据验证。
createResponse(response)ItemResponse为此文本项创建一个新的 ItemResponse
duplicate()TextItem创建此项目的副本,并将其附加到表单的末尾。
getGeneralFeedback()QuizFeedback返回回复者在回答可评分的问题后向其显示的反馈。
getHelpText()String获取该项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
getId()Integer获取项的唯一标识符。
getIndex()Integer获取表单中所有项中的项的索引。
getPoints()Integer返回可评分项的分值。
getTitle()String获取商品的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
getType()ItemType获取该项的类型,表示为 ItemType
isRequired()Boolean确定受访者是否必须回答问题。
setGeneralFeedback(feedback)TextItem设置在回复者回答没有正确或错误答案的可评分问题(例如,需要手动评分的问题)时向其显示反馈。
setHelpText(text)TextItem设置项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
setPoints(points)TextItem设置可评分项目的分值。
setRequired(enabled)TextItem设置受访者是否必须回答问题。
setTitle(title)TextItem设置项目的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
setValidation(validation)TextItem设置此文本项的数据验证。

TextValidation

TextValidationBuilder

方法

方法返回类型简介
requireNumber()TextValidationBuilder要求文本项必须为数字。
requireNumberBetween(start, end)TextValidationBuilder要求文本项必须是介于起始值和结束值之间的数字(含边界值)。
requireNumberEqualTo(number)TextValidationBuilder要求文本项是等于指定值的数字。
requireNumberGreaterThan(number)TextValidationBuilder要求文本项是大于指定值的数字。
requireNumberGreaterThanOrEqualTo(number)TextValidationBuilder要求文本项是大于或等于指定值的数字。
requireNumberLessThan(number)TextValidationBuilder要求文本项是小于指定值的数字。
requireNumberLessThanOrEqualTo(number)TextValidationBuilder要求文本项是小于或等于指定值的数字。
requireNumberNotBetween(start, end)TextValidationBuilder要求文本项必须是不在开始和结束之间的数字(包括开始值和结束值)。
requireNumberNotEqualTo(number)TextValidationBuilder要求文本项是不等于指定值的数字。
requireTextContainsPattern(pattern)TextValidationBuilder要求响应包含模式。
requireTextDoesNotContainPattern(pattern)TextValidationBuilder要求响应不得包含模式。
requireTextDoesNotMatchPattern(pattern)TextValidationBuilder要求响应与模式不匹配。
requireTextIsEmail()TextValidationBuilder要求文本项是电子邮件地址。
requireTextIsUrl()TextValidationBuilder文本项必须为网址。
requireTextLengthGreaterThanOrEqualTo(number)TextValidationBuilder要求响应长度大于或等于值。
requireTextLengthLessThanOrEqualTo(number)TextValidationBuilder要求响应长度小于值。
requireTextMatchesPattern(pattern)TextValidationBuilder需要响应以匹配模式。
requireWholeNumber()TextValidationBuilder要求文本项必须为整数。

TimeItem

方法

方法返回类型简介
createResponse(hour, minute)ItemResponse为此时间项创建新的 ItemResponse
duplicate()TimeItem创建此项目的副本,并将其附加到表单的末尾。
getGeneralFeedback()QuizFeedback返回回复者在回答可评分的问题后向其显示的反馈。
getHelpText()String获取该项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
getId()Integer获取项的唯一标识符。
getIndex()Integer获取表单中所有项中的项的索引。
getPoints()Integer返回可评分项的分值。
getTitle()String获取商品的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
getType()ItemType获取该项的类型,表示为 ItemType
isRequired()Boolean确定受访者是否必须回答问题。
setGeneralFeedback(feedback)TimeItem设置在回复者回答没有正确或错误答案的可评分问题(例如,需要手动评分的问题)时向其显示反馈。
setHelpText(text)TimeItem设置项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
setPoints(points)TimeItem设置可评分项目的分值。
setRequired(enabled)TimeItem设置受访者是否必须回答问题。
setTitle(title)TimeItem设置项目的标题(如果为 SectionHeaderItem,则有时称为标题文本)。

VideoItem

方法

方法返回类型简介
duplicate()VideoItem创建此项目的副本,并将其附加到表单的末尾。
getAlignment()Alignment获取视频的水平对齐方式。
getHelpText()String获取该项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
getId()Integer获取项的唯一标识符。
getIndex()Integer获取表单中所有项中的项的索引。
getTitle()String获取商品的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
getType()ItemType获取该项的类型,表示为 ItemType
getWidth()Integer获取视频的宽度(以像素为单位)。
setAlignment(alignment)VideoItem设置视频的水平对齐。
setHelpText(text)VideoItem设置项的帮助文本(有时称为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
setTitle(title)VideoItem设置项目的标题(如果为 SectionHeaderItem,则有时称为标题文本)。
setVideoUrl(youtubeUrl)VideoItem根据指定的 YouTube 网址或 YouTube 视频 ID 设置视频本身。
setWidth(width)VideoItem设置视频的宽度(以像素为单位)。