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

参数

名称类型说明
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