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 或创建新的 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。
RatingIconType表示支持的分级图标类型的枚举。
RatingItem允许回复者评分的题目项。
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添加了新的问题项,以便回复者输入一段文本。
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[]获取指定类型的所有项的数组。
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 的编辑者列表中移除指定用户。
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设置表单在受访者提交表单后是否显示用于查看回复摘要的链接。
setShowLinkToRespondAgain(enabled)Form设置表单在回复者填写完表单后是否显示用于提交另一份回复的链接。
setShuffleQuestions(shuffle)Form设置表单每个页面上问题的顺序是否为随机顺序。
setTitle(title)Form设置表单的标题。
shortenFormUrl(url)String将表单的长网址转换为短网址。
submitGrades(responses)Form提交给定 FormResponse 的成绩。

FormApp

属性

属性类型说明
AlignmentAlignment图片对齐类型的枚举。
DestinationTypeDestinationType可存储表单响应的目的地类型的枚举。
FeedbackTypeFeedbackTypeFeedbacks 格式的类型枚举。
ItemTypeItemTypeItems 格式的类型枚举。
PageNavigationTypePageNavigationType枚举了浏览网页的可能行为。
RatingIconTypeRatingIconType评分图标类型的枚举 RatingIcons

方法

方法返回类型简介
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以段落文本项的形式返回项。
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返回在回复者正确回答问题时向其显示的反馈。
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设置反馈文本。

RatingIconType

属性

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

RatingItem

方法

方法返回类型简介
createResponse(response)ItemResponse为此评分项创建新的 ItemResponse
duplicate()RatingItem创建此项的副本,并将其附加到表单的末尾。
getGeneralFeedback()QuizFeedback返回在回复可评分题目时向回答者显示的反馈。
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返回在回复可评分题目时向回答者显示的反馈。
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要求文本项为数字,且不介于 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设置视频的宽度(以像素为单位)。