Interface Item

商品

一种通用表单项，包含所有项共有的属性，例如标题和帮助文本。 可以通过 Form 访问或创建项目。

如需对特定于类型的属性执行操作，请使用 getType() 检查商品的 ItemType，然后使用 asCheckboxItem() 等方法将商品强制转换为相应的类。 

// Create a new form and add a text item.
const form = FormApp.create('Form Name');
form.addTextItem();

// Access the text item as a generic item.
const items = form.getItems();
const item = items[0];

// Cast the generic item to the text-item class.
if (item.getType() === 'TEXT') {
  const textItem = item.asTextItem();
  textItem.setRequired(false);
}

实现类

名称简介

方法

方法返回类型简介
asCheckboxGridItem()CheckboxGridItem以复选框网格项的形式返回相应项。
asCheckboxItem()CheckboxItem以复选框项的形式返回相应项。
asDateItem()DateItem以日期项的形式返回相应项。
asDateTimeItem()DateTimeItem以日期时间项的形式返回相应项。
asDurationItem()DurationItem以时长项的形式返回相应项。
asGridItem()GridItem以网格项的形式返回相应项。
asImageItem()ImageItem以图片商品的形式返回商品。
asListItem()ListItem以列表项的形式返回相应商品。
asMultipleChoiceItem()MultipleChoiceItem将相应项作为单选题返回。
asPageBreakItem()PageBreakItem以分页符项的形式返回相应项。
asParagraphTextItem()ParagraphTextItem以段落文本题的形式返回相应题目。
asRatingItem()RatingItem以评分项的形式返回相应商品。
asScaleItem()ScaleItem以比例项的形式返回相应商品。
asSectionHeaderItem()SectionHeaderItem以部分标题项的形式返回相应项。
asTextItem()TextItem以文本项的形式返回相应项。
asTimeItem()TimeItem以时间项的形式返回相应项。
asVideoItem()VideoItem以视频项的形式返回相应项。
duplicate()Item创建此题项的副本并将其附加到表单末尾。
getHelpText()String获取商品的帮助文本（有时称为布局项（如 ImageItems、PageBreakItems 和 SectionHeaderItems）的说明文本）。
getId()Integer获取商品的唯一标识符。
getIndex()Integer获取表单中相应商品在所有商品中的索引。
getTitle()String获取商品的标题（如果是 SectionHeaderItem，有时称为标题文字）。
getType()ItemType获取以 ItemType 表示的商品类型。
setHelpText(text)Item设置商品的帮助文本（有时称为布局项（如 ImageItems、PageBreakItems 和 SectionHeaderItems）的说明文本）。
setTitle(title)Item设置商品的标题（如果是 SectionHeaderItem，则有时称为标题文本）。

详细文档

asCheckboxGridItem()

以复选框网格项的形式返回相应项。如果 ItemType 尚未 CHECKBOX_GRID，则抛出脚本异常。

返回

CheckboxGridItem - 多选网格项

抛出

Error - 如果相应项不是复选框网格项

授权

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

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

asCheckboxItem()

以复选框项的形式返回相应项。如果 ItemType 尚未 CHECKBOX，则抛出脚本异常。

返回

CheckboxItem - 复选框项

抛出

Error - 如果相应项不是复选框项

授权

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

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

asDateItem()

以日期项的形式返回相应项。如果 ItemType 尚未 DATE，则抛出脚本异常。

返回

DateItem - 日期项

抛出

Error - 如果相应项不是日期项

授权

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

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

asDateTimeItem()

以日期时间项的形式返回相应项。如果 ItemType 尚未 DATETIME，则抛出脚本异常。

返回

DateTimeItem - 日期时间项

抛出

Error - 如果相应项不是日期时间项

授权

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

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

asDurationItem()

以时长项的形式返回相应项。如果 ItemType 尚未 DURATION，则抛出脚本异常。

返回

DurationItem - 时长项

抛出

Error - 如果相应商品不是时长商品

授权

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

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

asGridItem()

以网格项的形式返回相应项。如果 ItemType 尚未 GRID，则抛出脚本异常。

返回

GridItem - 网格项

抛出

Error - 如果相应项不是网格项

授权

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

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

asImageItem()

以图片项的形式返回相应项。如果 ItemType 尚未 IMAGE，则抛出脚本异常。

返回

ImageItem - 图片项

抛出

Error - 如果相应商品不是图片商品

asListItem()

以列表项的形式返回相应商品。如果 ItemType 尚未 LIST，则抛出脚本异常。

返回

ListItem - 列表项

抛出

Error - 如果相应项不是列表项

授权

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

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

asMultipleChoiceItem()

将相应项作为单选题返回。如果 ItemType 尚未 MULTIPLE_CHOICE，则抛出脚本异常。

返回

MultipleChoiceItem - 选择题内容

抛出

Error - 如果相应项不是多项选择题

授权

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

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

asPageBreakItem()

以分页符项的形式返回相应项。如果 ItemType 尚未 PAGE_BREAK，则抛出脚本异常。

返回

PageBreakItem - 分页符项

抛出

Error - 如果相应项不是分页符项

授权

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

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

asParagraphTextItem()

以段落文本题的形式返回相应题目。如果 ItemType 尚未 PARAGRAPH_TEXT，则抛出脚本异常。

返回

ParagraphTextItem - 段落文本项

抛出

Error - 如果相应项不是段落文本项

授权

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

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

asRatingItem()

以评分项的形式返回相应商品。如果 ItemType 尚未为 RATING，则抛出 ScriptingException。 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Fetch any item which is of type rating.
const item = form.getItems(FormApp.ItemType.RATING)[0];

// Convert the item to a rating item.
const ratingItem = item.asRatingItem();

返回

RatingItem - 评分项。

抛出

Error - 如果相应商品不是评分商品

授权

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

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

asScaleItem()

以比例项的形式返回相应项。如果 ItemType 尚未 SCALE，则抛出脚本异常。

返回

ScaleItem - 规模项

抛出

Error - 如果商品不是比例商品

授权

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

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

asSectionHeaderItem()

以部分标题项的形式返回相应项。如果 ItemType 尚未 SECTION_HEADER，则抛出脚本异常。

返回

SectionHeaderItem - section-header 项

抛出

Error - 如果相应项不是部分标题项

授权

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

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

asTextItem()

以文本项的形式返回相应项。如果 ItemType 尚未 TEXT，则抛出脚本异常。

返回

TextItem - 文本项

抛出

Error - 如果相应项不是文本项

授权

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

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

asTimeItem()

以时间项的形式返回相应项。如果 ItemType 尚未 TIME，则抛出脚本异常。

返回

TimeItem - 时间项

抛出

Error - 如果相应商品不是限时商品

授权

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

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

asVideoItem()

以视频项的形式返回相应项。如果 ItemType 尚未 VIDEO，则抛出脚本异常。

返回

VideoItem - 视频项

抛出

Error - 如果相应项不是视频项

duplicate()

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

返回

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

授权

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

  • 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

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

setHelpText(text)

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

参数

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

返回

Item - 此 Item，用于链式调用

授权

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

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

setTitle(title)

设置商品的标题（如果是 SectionHeaderItem，则有时称为标题文本）。

参数

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

返回

Item - 此 Item，用于链式调用

授权

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

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