Forms Service

表单

此服务允许脚本创建、访问和修改 Google 表单。

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

名称简介
Alignment表示支持的图片对齐类型的枚举。
CheckboxGridItem一种以列和行网格形式呈现的问题项,允许答题者从一系列复选框中为每行选择多个选项。
CheckboxGridValidation针对 CheckboxGridItem 的 DataValidation。
CheckboxGridValidationBuilder适用于 CheckboxGridValidation 的 DataValidationBuilder。
CheckboxItem一种问题项,允许答题者选择一个或多个复选框,以及一个可选的“其他”字段。
CheckboxValidation针对 CheckboxItem 的 DataValidation。
CheckboxValidationBuilder适用于 CheckboxValidation 的 DataValidationBuilder。
Choice与支持选项的 Item 类型(例如 CheckboxItemListItemMultipleChoiceItem)关联的单个选项。
DateItem一种允许答题者指明日期的题目。
DateTimeItem一种问题项,可让答题者指明日期和时间。
DestinationType一个枚举,表示支持的表单回复目标类型。
DurationItem一种允许答题者指明时间长度的问题项。
FeedbackType表示支持的反馈类型的枚举。
Form包含总体属性和项目的表单。
FormApp允许脚本打开现有 Form 或创建新 Form
FormResponse对整个表单的回答。
GridItem一种以列和行网格形式呈现的问题项,允许答题者从一系列单选按钮中为每行选择一个选项。
GridValidation针对 GridItem 的 DataValidation。
GridValidationBuilder适用于 GridValidation 的 DataValidationBuilder。
ImageItem用于显示图片的布局项。
Item一种通用表单项,包含所有项共有的属性,例如标题和帮助文本。
ItemResponse对表单中一个问题项的回答。
ItemType表示受支持的表单项类型的枚举。
ListItem一种问题项,可让答题者从下拉列表中选择一个选项。
MultipleChoiceItem一种问题项,允许答题者从单选按钮列表或可选的“其他”字段中选择一个选项。
PageBreakItem用于标记页面开头的布局项。
PageNavigationType一个枚举,表示支持的页面导航类型。
ParagraphTextItem一种允许答题者输入一段文字的问题项。
ParagraphTextValidation针对 ParagraphTextItem 的 DataValidation。
ParagraphTextValidationBuilder适用于 ParagraphTextValidation 的 DataValidationBuilder。
QuizFeedback反馈的 Bean 实现,包含所有反馈共有的属性,例如显示文本或链接。
QuizFeedbackBuilder包含所有反馈共有的属性(例如显示文本)的 setter 的基本 FeedbackBuilder。
RatingIconType表示支持的分级图标类型的枚举。
RatingItem一种允许答题者给出评分的问题项。
ScaleItem一种问题项,可让答题者从一组按编号排列的单选按钮中选择一个选项。
SectionHeaderItem直观指示部分开头的布局项。
TextItem一种问题项,允许答题者输入单行文本。
TextValidation针对 TextItem 的 DataValidation。
TextValidationBuilder适用于 TextValidation 的 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|null返回当答题者正确回答问题时向其显示的反馈。
getFeedbackForIncorrect()QuizFeedback|null返回向回答者显示的反馈,当回答者对问题做出错误回答时,系统会显示此反馈。
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如果回答者选择此选项并完成当前页面,则将 PageBreakItem 设置为 GO_TO_PAGE 目的地。
getPageNavigationType()PageNavigationType获取当回答者选择此选项并完成当前页面时发生的 PageNavigationType
getValue()String获取选项的值,受访者在查看表单时会看到该值作为标签。
isCorrectAnswer()Boolean获取相应选项是否为问题的正确答案。

DateItem

方法

方法返回类型简介
createResponse(response)ItemResponse为此日期项创建新的 ItemResponse
duplicate()DateItem创建此题目的副本并将其附加到表单末尾。
getGeneralFeedback()QuizFeedback|null返回受访者回答可评分问题时向其显示的反馈。
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|null返回受访者回答可评分问题时向其显示的反馈。
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|null返回受访者回答可评分问题时向其显示的反馈。
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添加一个新问题项,允许答题者输入一段文本。
addPublishedReader(emailAddress)Form将指定用户添加到 Form 的回答者列表中。
addPublishedReader(user)Form将指定用户添加到 Form 的回答者列表中。
addPublishedReaders(emailAddresses)Form将指定的用户数组添加到 Form 的回答者列表中。
addRatingItem()RatingItem附加一个新问题项,允许答题者给出评分。
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[]获取指定类型的所有商品的数组。
getPublishedReaders()User[]获取相应 Form 的回答者列表。
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确定表单目前是否接受回答。
isPublished()Boolean确定表单是否已发布。
isPublishingSummary()Boolean确定在答题者完成表单后,表单是否显示用于查看回答摘要的链接。
isQuiz()Boolean确定表单是否为测验。
moveItem(from, to)Item将表单中指定索引处的项移动到另一个指定索引处。
moveItem(item, toIndex)Item将指定项移动到表单中所有项的指定索引处。
removeDestination()Form将表单与其当前回复目标取消关联。
removeEditor(emailAddress)FormForm 的编辑者列表中移除指定用户。
removeEditor(user)FormForm 的编辑者列表中移除指定用户。
removePublishedReader(emailAddress)FormForm 的回答者列表中移除指定用户。
removePublishedReader(user)FormForm 的回答者列表中移除指定用户。
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设置表单是否具有进度条。
setPublished(enabled)Form设置表单是否已发布。
setPublishingSummary(enabled)Form设置在受访者提交表单后,表单是否显示用于查看回复摘要的链接。
setShowLinkToRespondAgain(enabled)Form设置表单在答题者完成表单后是否显示用于提交另一份回复的链接。
setShuffleQuestions(shuffle)Form设置表单上每个页面的问题顺序是否随机。
setTitle(title)Form设置表单的标题。
shortenFormUrl(url)String将表单的长网址转换为短网址。
submitGrades(responses)Form提交指定 FormResponses 的成绩。
supportsAdvancedResponderPermissions()Boolean确定表单是否支持发布。

FormApp

属性

属性类型说明
AlignmentAlignment图片对齐方式的枚举。
DestinationTypeDestinationType可存储表单回答的目标类型的枚举。
FeedbackTypeFeedbackTypeFeedbacks 形式的类型的枚举。
ItemTypeItemTypeItems 形式的类型的枚举。
PageNavigationTypePageNavigationType一个枚举,包含可能的网页浏览行为。
RatingIconTypeRatingIconType评分图标类型的枚举 RatingIcons

方法

方法返回类型简介
create(title)Form创建并返回新的 Form
create(title, isPublished)Form创建并返回处于所请求发布状态的新 Form
createCheckboxGridValidation()CheckboxGridValidationBuilder返回 CheckboxGridValidationBuilder 的实例,该实例可用于对 CheckboxGridItem 设置验证。
createCheckboxValidation()CheckboxValidationBuilder返回一个 CheckboxValidationBuilder 实例,该实例可用于对 CheckboxItem 设置验证。
createFeedback()QuizFeedbackBuilder返回 QuizFeedbackBuilder 的一个实例,该实例可用于设置可评分 Item 的反馈。
createGridValidation()GridValidationBuilder返回 GridValidationBuilder 的一个实例,该实例可用于在 GridItem 上设置验证。
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|null获取表单回答的 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以段落文本题的形式返回相应题目。
asRatingItem()RatingItem以评分项的形式返回相应商品。
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一种允许答题者输入一段文字的问题项。
RATINGEnum一种允许答题者给出评分的问题项。
SCALEEnum一种问题项,可让回答者从一组按数字顺序排列的单选按钮中选择一个选项。
SECTION_HEADEREnum直观指示部分开头的布局项。
TEXTEnum一种问题项,允许答题者输入单行文本。
TIMEEnum一种问题项,可让答题者指明一天中的某个时间。
VIDEOEnum用于显示 YouTube 视频的布局项。
FILE_UPLOADEnum一种问题项,可让答题者上传文件。
UNSUPPORTEDEnum目前不支持通过 API 进行操作的商品。

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|null返回当答题者正确回答问题时向其显示的反馈。
getFeedbackForIncorrect()QuizFeedback|null返回向回答者显示的反馈,当回答者对问题做出错误回答时,系统会显示此反馈。
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|null返回当答题者正确回答问题时向其显示的反馈。
getFeedbackForIncorrect()QuizFeedback|null返回向回答者显示的反馈,当回答者对问题做出错误回答时,系统会显示此反馈。
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|null返回受访者回答可评分问题时向其显示的反馈。
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设置反馈文本。

RatingIconType

属性

属性类型说明
STAREnum星形图标。
HEARTEnum心形图标。
THUMB_UPEnum“我喜欢”图标。

RatingItem

方法

方法返回类型简介
createResponse(response)ItemResponse为此评分项创建新的 ItemResponse
duplicate()RatingItem创建此题目的副本并将其附加到表单末尾。
getGeneralFeedback()QuizFeedback|null返回受访者回答可评分问题时向其显示的反馈。
getHelpText()String获取商品的帮助文本(有时称为布局项(如 ImageItemsPageBreakItemsSectionHeaderItems)的说明文本)。
getId()Integer获取商品的唯一标识符。
getIndex()Integer获取表单中相应商品在所有商品中的索引。
getPoints()Integer返回可评分项目的分数。
getRatingIcon()RatingIconType获取为相应评分选择的图标。
getRatingScaleLevel()Integer获取相应评级的缩放级别。
getTitle()String获取商品的标题(如果是 SectionHeaderItem,则有时称为标题文字)。
getType()ItemType获取以 ItemType 表示的商品类型。
isRequired()Boolean确定答题者是否必须回答问题。
setGeneralFeedback(feedback)RatingItem设置在回复者回答没有正确或错误答案的可评分问题(即需要人工评分的问题)时向其显示的反馈。
setHelpText(text)RatingItem设置商品的帮助文本(有时称为布局项(如 ImageItemsPageBreakItemsSectionHeaderItems)的说明文本)。
setPoints(points)RatingItem设置可评分项目的分值。
setRatingIcon(ratingIcon)RatingItem设置评分的图标。
setRatingScaleLevel(ratingScaleLevel)RatingItem设置评分的最大等级。
setRequired(enabled)RatingItem设置答题者是否必须回答相应问题。
setTitle(title)RatingItem设置商品的标题(如果是 SectionHeaderItem,有时称为标题文字)。

ScaleItem

方法

方法返回类型简介
createResponse(response)ItemResponse为此缩放项创建新的 ItemResponse
duplicate()ScaleItem创建此题目的副本并将其附加到表单末尾。
getGeneralFeedback()QuizFeedback|null返回受访者回答可评分问题时向其显示的反馈。
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|null返回受访者回答可评分问题时向其显示的反馈。
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|null返回受访者回答可评分问题时向其显示的反馈。
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设置视频的宽度(以像素为单位)。