Interface Item

商品

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

如需对类型特有属性执行操作，请使用 getType() 检查相应内容的 ItemType，然后使用 asCheckboxItem() 等方法将相应内容投射到相应的类。 

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

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

// Cast the generic item to the text-item class.
if (item.getType() == 'TEXT') {
  var 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以段落文本形式返回内容。
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

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