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|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,有时称为标题文字)。

详细文档

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_PAGEcreateChoice(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|null - 反馈(如果有)。

授权

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

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

getFeedbackForIncorrect()

返回向回答者显示的反馈,当回答者对问题做出错误回答时,系统会显示此反馈。

返回

QuizFeedback|null - 反馈(如果有)。

授权

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

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

getHelpText()

获取商品的帮助文本(有时称为布局项(如 ImageItemsPageBreakItemsSectionHeaderItems)的说明文本)。

返回

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)

设置商品的帮助文本(有时称为布局项(如 ImageItemsPageBreakItemsSectionHeaderItems)的说明文本)。

参数

名称类型说明
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