Class ListItem

ListItem

允许受访者从下拉列表中选择的一个问题项。您可以通过 Form 访问或创建项。

// Open a form by ID and add a new list item.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var 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获取项的帮助文本(有时称为 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 - 反馈(如果有)。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • 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()

获取项的帮助文本(有时称为 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.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var 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.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var 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.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var 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