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取得項目的專屬 ID。
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()

取得項目的專屬 ID。

回攻員

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