Class CheckboxItem

复选框项

一个问题项，可让受访者选择一个或多个复选框，以及一个可选的“其他”字段。您可以通过 Form 访问或创建项。在知识问答中使用这些题目时，系统会自动为其评分。

// Open a form by ID and add a new checkbox item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addCheckboxItem();
item.setTitle('What condiments would you like on your hot dog?')
    .setChoices([
      item.createChoice('Ketchup'),
      item.createChoice('Mustard'),
      item.createChoice('Relish'),
    ])
    .showOtherOption(true);

方法

方法	返回类型	简介
clearValidation()	CheckboxItem	移除此复选框项的所有数据验证。
createChoice(value)	Choice	创建新选项。
createChoice(value, isCorrect)	Choice	创建新选项。
createResponse(responses)	ItemResponse	为此复选框项创建新的 ItemResponse。
duplicate()	CheckboxItem	创建此项的副本，并将其附加到表单的末尾。
getChoices()	Choice[]	获取商品的所有选项。
getFeedbackForCorrect()	QuizFeedback	返回在回复者正确回答问题时向其显示的反馈。
getFeedbackForIncorrect()	QuizFeedback	返回在回复者对某个问题回答错误时向其显示的反馈。
getHelpText()	String	获取项的帮助文本（对于 ImageItems、PageBreakItems 和 SectionHeaderItems 等布局项，有时也称为说明文本）。
getId()	Integer	获取内容的唯一标识符。
getIndex()	Integer	获取表单中所有项中的项的索引。
getPoints()	Integer	返回可评分的项的分值。
getTitle()	String	获取项的标题（对于 SectionHeaderItem，有时称为标题文本）。
getType()	ItemType	获取项的类型，表示为 ItemType。
hasOtherOption()	Boolean	确定相应项是否包含“其他”选项。
isRequired()	Boolean	确定回复者是否必须回答该问题。
setChoiceValues(values)	CheckboxItem	从字符串数组中为项设置选项。
setChoices(choices)	CheckboxItem	为项设置一个选项数组。
setFeedbackForCorrect(feedback)	CheckboxItem	设置在回复者正确回答问题时向其显示的反馈。
setFeedbackForIncorrect(feedback)	CheckboxItem	设置在回复者对某个问题回答错误时向其显示的反馈。
setHelpText(text)	CheckboxItem	设置项的帮助文本（对于布局项，有时称为说明文本，例如 ImageItems、PageBreakItems 和 SectionHeaderItems）。
setPoints(points)	CheckboxItem	设置可评分的项目的分值。
setRequired(enabled)	CheckboxItem	设置回复者是否必须回答该问题。
setTitle(title)	CheckboxItem	设置项的标题（对于 SectionHeaderItem，有时称为标题文本）。
setValidation(validation)	CheckboxItem	为此复选框项设置数据验证。
showOtherOption(enabled)	CheckboxItem	设置项是否具有“其他”选项。

详细文档

clearValidation()

移除此复选框项的所有数据验证。

返回

CheckboxItem - 此 CheckboxItem，用于链式调用

授权

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

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

---

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

---

createResponse(responses)

为此复选框项创建新的 ItemResponse。参数 responses 是一个 String[] 数组，其中包含需要检查的值。如果任何值与此项的有效选项不匹配，则会抛出异常，除非 showOtherOption(enabled) 已设置为 true。

参数

名称	类型	说明
responses	String[]	此多选题的有效答案数组

返回

ItemResponse - 内容响应

授权

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

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

---

duplicate()

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

返回

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

授权

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

• 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

---

hasOtherOption()

确定相应项是否包含“其他”选项。

返回

Boolean - 如果商品有“其他”选项，则为 true；否则为 false

授权

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

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

参数

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

返回

CheckboxItem - 此 CheckboxItem，用于链式调用

授权

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

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

参数

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

返回

CheckboxItem - 此 CheckboxItem，用于链式调用

抛出

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

参数

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

返回

CheckboxItem - 此 CheckboxItem，用于链式调用

授权

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

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

---

setFeedbackForIncorrect(feedback)

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

参数

名称	类型	说明
feedback	QuizFeedback	新反馈

返回

CheckboxItem - 此 CheckboxItem，用于链式调用

授权

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

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

---

setHelpText(text)

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

参数

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

返回

CheckboxItem - 此 CheckboxItem，用于链式调用

授权

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

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

---

setPoints(points)

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

参数

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

返回

CheckboxItem - 此 CheckboxItem，用于链式调用

授权

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

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

---

setRequired(enabled)

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

参数

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

返回

CheckboxItem - 当前项（用于链接）

授权

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

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

---

setTitle(title)

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

参数

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

返回

CheckboxItem - 此 CheckboxItem，用于链式调用

授权

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

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

---

setValidation(validation)

设置此复选框项的数据验证。如果传入 null 或未调用任何 require 函数的验证，则会移除所有之前的验证。

参数

名称	类型	说明
validation	CheckboxValidation	要应用于此项的 CheckboxValidation。

返回

CheckboxItem - 此 CheckboxItem，用于链式调用

授权

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

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

---

showOtherOption(enabled)

设置项是否具有“其他”选项。新 CheckboxItem 或 MultipleChoiceItem 的默认值为 false。

参数

名称	类型	说明
enabled	Boolean	如果商品有“其他”选项，则为 true；否则为 false

返回

CheckboxItem - 此 CheckboxItem，用于链式调用

授权

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

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