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或创建新的实例。
FormResponse对整个表单的响应。
GridItem问题项,以列和行网格的形式呈现,供受访者进行选择 一系列单选按钮,每行一个选项。
GridValidationGridItem 的 DataValidation。
GridValidationBuilderGridValidation 的 DataValidationBuilder。
ImageItem显示图片的布局项。
Item通用表单项,包含所有项共有的属性,例如标题和帮助文本。
ItemResponse对表单中一个问题的回复。
ItemType表示支持的表单项类型的枚举。
ListItem可让回复者从下拉列表中选择一个选项的问题。
MultipleChoiceItem可让回复者从单选按钮列表中选择一个选项的问题, 可选的“other”字段。
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)FormForm 的编辑器列表添加给定的一组用户。
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返回 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获取表单回复的 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可让回复者从单选按钮列表中选择一个选项的问题, 可选的“other”字段。
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文本项必须是介于 start 和 end 之间的数字(含首尾数字)。
requireNumberEqualTo(number)TextValidationBuilder文本项必须是等于指定值的数字。
requireNumberGreaterThan(number)TextValidationBuilder要求文本项是大于指定值的数字。
requireNumberGreaterThanOrEqualTo(number)TextValidationBuilder要求文本项是大于或等于指定值的数字。
requireNumberLessThan(number)TextValidationBuilder文本项必须是小于指定值的数字。
requireNumberLessThanOrEqualTo(number)TextValidationBuilder要求文本项是小于或等于指定值的数字。
requireNumberNotBetween(start, end)TextValidationBuilder文本项必须是不介于 start 和 end 之间的数字(含首尾数字)。
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设置视频的宽度(以像素为单位)。