此页面由 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)`

创建一个新选项，其中包含一个可跳转到给定分页符项的页面导航选项。这相当于将 createChoice(value, navigationType) 设置为 FormApp.PageNavigationType.GO_TO_PAGE。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