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与支持选择的 Item 类型相关联的单个选项,例如 CheckboxItemListItemMultipleChoiceItem
DateItem允许受访者指明日期的问题。
DateTimeItem允许回复者指明日期和时间的问题。
DestinationType表示支持的表单回复目的地类型的枚举。
DurationItem允许回复者指示时间长度的问题。
FeedbackType表示支持的反馈类型的枚举。
Form包含整体属性和项目的表单。
FormApp允许脚本打开现有 Form 或创建新脚本。
FormResponse对表单整体的响应。
GridItem以列和行网格表示的问题项,可让受访者从一系列单选按钮中选择一行。
GridValidationGridItem 的 DataValidation。
GridValidationBuilderGridValidation 的 DataValidationBuilder。
ImageItem用于显示图片的布局项。
Item一个通用表单项目,包含所有产品通用的属性,例如标题和帮助文本。
ItemResponse对表单中的一个问题项的响应。
ItemType表示支持的表单项类型的枚举。
ListItem允许受访者从下拉列表中选择的一个问题项。
MultipleChoiceItem允许受访者从单选按钮列表或可选的“其他”字段中选择一个选项的选项。
PageBreakItem用于标记页面开头的布局项。
PageNavigationType表示支持的页面导航类型的枚举。
ParagraphTextItem允许受访者输入文本块的题目。
ParagraphTextValidationParagraphTextItem 的 DataValidation。
ParagraphTextValidationBuilderParagraphTextValidation 的 DataValidationBuilder。
QuizFeedbackFeedback 的 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为指定的 FormResponses 提交成绩。

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返回可用于对 TextItem 设置验证结果的 TextValidationBuilder 实例。
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向表单响应添加指定的 item 响应。

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设置视频的宽度(以像素为单位)。