本頁面由 Cloud Translation API 翻譯而成。

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`	取得項目的專屬 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

`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()`

取得項目的專屬 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 等版面配置項目，有時稱為說明文字)。

參數

名稱	類型	說明
`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