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 - 版块标题项

抛出

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）。

参数

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

Item - 此 Item，用于链式调用

授权

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

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

`setTitle(title)`

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

参数

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

Item - 此 Item，用于链式调用

授权

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

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

Interface Item 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

实现类

方法

详细文档

asCheckboxGridItem()

返回

抛出

授权

asCheckboxItem()

返回

抛出

授权

asDateItem()

返回

抛出

授权

asDateTimeItem()

返回

抛出

授权

asDurationItem()

返回

抛出

授权

asGridItem()

返回

抛出

授权

asImageItem()

返回

抛出

asListItem()

返回

抛出

授权

asMultipleChoiceItem()

返回

抛出

授权

asPageBreakItem()

返回

抛出

授权

asParagraphTextItem()

返回

抛出

授权

asRatingItem()

返回

抛出

授权

asScaleItem()

返回

抛出

授权

asSectionHeaderItem()

返回

抛出

授权

asTextItem()

返回

抛出

授权

asTimeItem()

返回

抛出

授权

asVideoItem()

返回

抛出

duplicate()

返回

授权

getHelpText()

返回

授权

getId()

返回

授权

getIndex()

Interface Item

`asCheckboxGridItem()`

`asCheckboxItem()`

`asDateItem()`

`asDateTimeItem()`

`asDurationItem()`

`asGridItem()`

`asImageItem()`

`asListItem()`

`asMultipleChoiceItem()`

`asPageBreakItem()`

`asParagraphTextItem()`

`asRatingItem()`

`asScaleItem()`

`asSectionHeaderItem()`

`asTextItem()`

`asTimeItem()`

`asVideoItem()`

`duplicate()`

`getHelpText()`

`getId()`

`getIndex()`

`getTitle()`

`getType()`

`setHelpText(text)`

`setTitle(title)`