Class RatingItem

RatingItem

允许回复者评分的题目项。您可以通过 Form 访问或创建内容。在知识问答中使用这些题目时,系统会为其评分。

// Open a form by ID
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

// Get an existing rating item and access its properties.
const existingRatingItem = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();
const ratingScaleLevel = existingRatingItem.getRatingScaleLevel();
const ratingIcon = existingRatingItem.getRatingIcon();

// Create a new rating item.
const ratingItem = form.addRatingItem();

// Update the rating item's properties via chaining.
ratingItem.setRatingScaleLevel(7).setRatingIcon(FormApp.RatingIconType.HEART);

方法

方法返回类型简介
createResponse(response)ItemResponse为此评分项创建新的 ItemResponse
duplicate()RatingItem创建此项的副本,并将其附加到表单的末尾。
getGeneralFeedback()QuizFeedback返回在回复可评分题目时向回答者显示的反馈。
getHelpText()String获取项的帮助文本(对于 ImageItemsPageBreakItemsSectionHeaderItems 等布局项,有时也称为说明文本)。
getId()Integer获取内容的唯一标识符。
getIndex()Integer获取表单中所有项中的项的索引。
getPoints()Integer返回可评分的项的分值。
getRatingIcon()RatingIconType获取为评分选择的图标。
getRatingScaleLevel()Integer获取评分的量表等级。
getTitle()String获取项的标题(对于 SectionHeaderItem,有时称为标题文本)。
getType()ItemType获取项的类型,表示为 ItemType
isRequired()Boolean确定回复者是否必须回答该问题。
setGeneralFeedback(feedback)RatingItem设置在回复者回答没有正确或错误答案的可评分问题(即需要手动评分的题目)时向其显示的反馈。
setHelpText(text)RatingItem设置项的帮助文本(对于布局项,有时也称为说明文本,例如 ImageItemsPageBreakItemsSectionHeaderItems)。
setPoints(points)RatingItem设置可评分的项目的分值。
setRatingIcon(ratingIcon)RatingItem设置分级的图标。
setRatingScaleLevel(ratingScaleLevel)RatingItem设置评分的量表级别。
setRequired(enabled)RatingItem设置回复者是否必须回答该问题。
setTitle(title)RatingItem设置项的标题(对于 SectionHeaderItem,有时称为标题文本)。

详细文档

createResponse(response)

为此评分项创建新的 ItemResponse

如果提供的 response 小于 1 或大于 getRatingScaleLevel() 返回的值,则会抛出脚本异常。

// Open a form by ID
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

// Get an existing rating item and create a new response for it.
const item = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();
const response =item.createResponse(5);

参数

名称类型说明
responseInteger此评分项的值回答。

返回

ItemResponse - 商品响应。

授权

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

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

duplicate()

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

返回

RatingItem - 此 RatingItem 的副本,用于链式调用

授权

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

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

getGeneralFeedback()

返回在回复可评分题目时向回答者显示的反馈。

返回

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

getRatingIcon()

获取为评分选择的图标。

// Open a form by ID
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

// Get an existing rating item and get its rating icon.
const item = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();
const ratingIcon = item.getRatingIcon();

返回

RatingIconType - 评分图标类型。

授权

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

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

getRatingScaleLevel()

获取评分的量表等级。

// Open a form by ID
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

// Get an existing rating item and get its rating scale level.
const item = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();
const ratingScaleLevel = item.getRatingScaleLevel();

返回

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

setGeneralFeedback(feedback)

设置在回复者回答没有正确或错误答案的可评分问题(即需要手动评分的题目)时向其显示的反馈。

参数

名称类型说明
feedbackQuizFeedback新反馈

返回

RatingItem - 此 RatingItem,用于链式调用

授权

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

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

setHelpText(text)

设置项的帮助文本(对于布局项,有时也称为说明文本,例如 ImageItemsPageBreakItemsSectionHeaderItems)。

参数

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

返回

RatingItem - 此 RatingItem,用于链式调用

授权

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

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

setPoints(points)

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

参数

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

返回

RatingItem - 此 RatingItem,用于链式调用

授权

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

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

setRatingIcon(ratingIcon)

设置分级的图标。

如果分级图标类型无效,则会抛出脚本异常。

// Open a form by ID
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

// Get an existing rating item and set its rating icon.
const item = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();
item.setRatingIcon(FormApp.RatingIconType.THUMB_UP);

参数

名称类型说明
ratingIconRatingIconType分级图标类型。

返回

RatingItem - 此 RatingItem,用于链式调用。

抛出

Error - 如果分级图标类型无效

授权

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

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

setRatingScaleLevel(ratingScaleLevel)

设置评分的量表级别。评分标准级别必须介于 310 之间(包括这两个数值)。新评分默认采用评分标准等级 3

如果给定值超出允许的限制,则会抛出脚本异常。

// Open a form by ID
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

// Get an existing rating item and set its rating scale level.
const item = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();
item.setRatingScaleLevel(7);

参数

名称类型说明
ratingScaleLevelInteger评分量表等级。

返回

RatingItem - 此 RatingItem,用于链式调用。

抛出

Error - 如果评分标准等级无效

授权

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

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

setRequired(enabled)

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

参数

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

返回

RatingItem - 当前项(用于链接)

授权

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

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

setTitle(title)

设置项的标题(对于 SectionHeaderItem,有时称为标题文本)。

参数

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

返回

RatingItem - 此 RatingItem,用于链式调用

授权

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

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