此页面由 Cloud Translation API 翻译。

Class 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`	获取相应项的帮助文本（对于 `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)`

创建新选项。

参数

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

Choice - 新选择

授权

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

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

`createChoice(value, isCorrect)`

创建新选项。

参数

名称	类型	说明
`value`	`String`	选项的值，受访者在查看表单时将其视为标签
`isCorrect`	`Boolean`	该选择是否正确

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)。使用页面的选项导航元素不能与不使用页面导航的选项结合使用。

网页导航发生在受访者完成包含选项的网页之后，前提是回复者选择该选项。如果回复者针对网页导航说明，则只有最后一个导航选项会起作用。页面导航对表单的最后一页没有影响。

参数

名称	类型	说明
`value`	`String`	选项的值，受访者在查看表单时将其视为标签
`navigationItem`	`PageBreakItem`	要导航到的项

Choice - 新选择

授权

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

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

`createChoice(value, navigationType)`

创建包含页面导航选项的新选项。使用页面导航的选项不得与不使用网页导航的选项组合到同一项中。

参数

名称	类型	说明
`value`	`String`	选项的值，受访者在查看表单时将其视为标签
`navigationType`	`PageNavigationType`	选项的导航类型

Choice - 新选择

授权

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

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

`createResponse(response)`

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

参数

名称	类型	说明
`response`	`String`	此列表项的有效答案

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.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoiceValues(['Dogs', 'Cats']);

参数

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

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')
]);

参数

名称	类型	说明
`choices`	`Choice[]`	选项数组

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

参数

名称	类型	说明
`feedback`	`QuizFeedback`	新反馈。null 值将清除反馈。

ListItem - 此 ListItem，用于链接

授权

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

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

`setFeedbackForIncorrect(feedback)`

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

参数

名称	类型	说明
`feedback`	`QuizFeedback`	新反馈

ListItem - 此 ListItem，用于链接

授权

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

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

`setHelpText(text)`

设置项的帮助文本（有时为 ImageItems、PageBreakItems 和 SectionHeaderItems 等布局项的说明文本）。

参数

名称	类型	说明
`text`	`String`	新的帮助文本

ListItem - 此 ListItem，用于链接

授权

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

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

`setPoints(points)`

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

参数

名称	类型	说明
`points`	`Integer`	问题项的分值

ListItem - 此 ListItem，用于链接

授权

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

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

`setRequired(enabled)`

设置受访者是否必须回答问题。

参数

名称	类型	说明
`enabled`	`Boolean`	受访者是否必须回答问题

ListItem - 当前项（用于链式）

授权

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

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

`setTitle(title)`

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

参数

名称	类型	说明
`title`	`String`	新的标题文字

ListItem - 此 ListItem，用于链接

授权

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

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