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