Class ListItem

列表项

一种题目项，可让受访者从下拉列表中选择一个选项。您可以通过 Form 访问或创建项。 

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?').setChoices([
  item.createChoice('Cats'), item.createChoice('Dogs')
]);

方法

方法返回类型简介
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获取项的帮助文本（对于 ImageItems、PageBreakItems 和 SectionHeaderItems 等布局项，有时也称为说明文本）。
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设置项的帮助文本（对于布局项，有时也称为说明文本，例如 ImageItems、PageBreakItems 和 SectionHeaderItems）。
setPoints(points)ListItem设置可评分的项目的分值。
setRequired(enabled)ListItem设置回复者是否必须回答该问题。
setTitle(title)ListItem设置项的标题（对于 SectionHeaderItem，有时称为标题文本）。

详细文档

createChoice(value)

创建新选项。

参数

名称类型说明
valueString选项的值，受访者在查看表单时会将其视为标签

返回

Choice - 新选项

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

createChoice(value, isCorrect)

创建新选项。

参数

名称类型说明
valueString选项的值，受访者在查看表单时会将其视为标签
isCorrectBoolean选项是否为正确答案

返回

Choice - 新选项

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

createChoice(value, navigationItem)

创建一个包含跳转到给定分页项的页面导航选项的新选项。这相当于将 navigationType 设置为 FormApp.PageNavigationType.GO_TO_PAGE 的 createChoice(value, navigationType)。使用页面导航的选项不能与不使用页面导航的选项在同一项中组合使用。

只有在回复者选择相应选项并完成包含该选项的页面后，系统才会执行网页导航。如果回复者在同一页面上选择了多个包含页面导航说明的选项，则只有最后一个导航选项有效。网页导航对表单的最后一页也没有影响。

参数

名称类型说明
valueString选项的值，受访者在查看表单时会将其视为标签
navigationItemPageBreakItem要导航到的项

返回

Choice - 新选项

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

createChoice(value, navigationType)

使用页面导航选项创建新的选项。使用页面导航的选项不能与不使用页面导航的选项在同一项中组合使用。

只有在回复者选择相应选项并完成包含该选项的页面后，系统才会执行网页导航。如果回复者在同一页面上选择了多个包含页面导航说明的选项，则只有最后一个导航选项有效。网页导航对表单的最后一页也没有影响。

参数

名称类型说明
valueString选项的值，受访者在查看表单时会将其视为标签
navigationTypePageNavigationType选项的导航类型

返回

Choice - 新选项

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

createResponse(response)

为此列表项创建新的 ItemResponse。如果 response 参数与此项的有效选项不匹配，则会抛出异常。

参数

名称类型说明
responseString此列表项的有效答案

返回

ItemResponse - 内容响应

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

duplicate()

创建此项的副本，并将其附加到表单的末尾。

返回

ListItem - 此 ListItem 的副本，用于链式调用

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getChoices()

获取商品的所有选项。

返回

Choice[] - 选项数组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getFeedbackForCorrect()

返回在回复者正确回答问题时向其显示的反馈。

返回

QuizFeedback - 反馈（如果有）。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getFeedbackForIncorrect()

返回在回复者对某个问题回答错误时向其显示的反馈。

返回

QuizFeedback - 反馈（如果有）。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getHelpText()

获取项的帮助文本（对于 ImageItems、PageBreakItems 和 SectionHeaderItems 等布局项，有时也称为说明文本）。

返回

String - 商品的帮助文本或说明文字

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getId()

获取内容的唯一标识符。

返回

Integer - 商品的 ID

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getIndex()

获取表单中所有项中的项的索引。

返回

Integer - 项的索引

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getPoints()

返回可评分的项的分值。

返回

Integer - 题目的分值。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getTitle()

获取项的标题（对于 SectionHeaderItem，有时称为标题文本）。

返回

String - 商品的标题或标题文本

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getType()

获取项的类型，表示为 ItemType。

返回

ItemType - 内容的类型

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

isRequired()

确定回复者是否必须回答该问题。

返回

Boolean - 回复者是否必须回答此问题

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setChoiceValues(values)

从字符串数组中为项设置选项。如果给定数组为空，则会抛出异常。 

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoiceValues(['Dogs', 'Cats']);

参数

名称类型说明
valuesString[]选项值数组，受访者在查看表单时会将其视为标签

返回

ListItem - 此 ListItem，用于链式调用

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setChoices(choices)

为项设置一个选项数组。如果给定数组为空或包含 null 元素，则会抛出异常。 

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoices([item.createChoice('Cats'), item.createChoice('Dogs')]);

参数

名称类型说明
choicesChoice[]选项数组

返回

ListItem - 此 ListItem，用于链式调用

抛出

Error - 如果给定数组为 null、为空或包含 null 元素

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setFeedbackForCorrect(feedback)

设置在回复者正确回答问题时向其显示的反馈。 

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
// Set "Dogs" as the correct answer to this question.
item.setChoices([
  item.createChoice('Dogs', true),
  item.createChoice('Cats', false),
]);
// Add feedback which will be shown for correct responses; ie "Dogs".
item.setFeedbackForCorrect(
    FormApp.createFeedback().setDisplayText('Dogs rule, cats drool.').build(),
);

参数

名称类型说明
feedbackQuizFeedback新反馈。null 值会清除反馈。

返回

ListItem - 此 ListItem，用于链式调用

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setFeedbackForIncorrect(feedback)

设置在回复者对某个问题回答错误时向其显示的反馈。

参数

名称类型说明
feedbackQuizFeedback新反馈

返回

ListItem - 此 ListItem，用于链式调用

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setHelpText(text)

设置项的帮助文本（对于布局项，有时也称为说明文本，例如 ImageItems、PageBreakItems 和 SectionHeaderItems）。

参数

名称类型说明
textString新的帮助文本

返回

ListItem - 此 ListItem，用于链式调用

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setPoints(points)

设置可评分的项目的分值。新商品的默认值为 0。

参数

名称类型说明
pointsInteger题目项对应的分数

返回

ListItem - 此 ListItem，用于链式调用

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setRequired(enabled)

设置回复者是否必须回答该问题。

参数

名称类型说明
enabledBoolean受访者是否必须回答此问题

返回

ListItem - 当前项（用于链接）

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setTitle(title)

设置项的标题（对于 SectionHeaderItem，有时称为标题文本）。

参数

名称类型说明
titleString新标题或标题文字

返回

ListItem - 此 ListItem，用于链式调用

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms