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

Class ListItem

允許受訪者從下拉式清單中選取一個選項的問題項目。您可以透過 Form 存取或建立項目。

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?').setChoices([
  item.createChoice('Cats'), item.createChoice('Dogs')
]);

方法

方法	傳回類型	簡短說明
`createChoice(value)`	`Choice`	建立新選項。
`createChoice(value, isCorrect)`	`Choice`	建立新選項。
`createChoice(value, navigationItem)`	`Choice`	建立新的選項，其中包含可跳至特定分頁項目的頁面導覽選項。
`createChoice(value, navigationType)`	`Choice`	使用頁面導覽選項建立新選項。
`createResponse(response)`	`ItemResponse`	為這個清單項目建立新的 `ItemResponse`。
`duplicate()`	`ListItem`	建立此項目的副本，並附加至表單結尾。
`getChoices()`	`Choice[]`	取得項目的所有選項。
`getFeedbackForCorrect()`	`QuizFeedback`	在作答者正確回答問題時，傳回要向他們顯示的意見回饋。
`getFeedbackForIncorrect()`	`QuizFeedback`	當作答者回答問題時，系統會傳回這項回饋。
`getHelpText()`	`String`	取得項目的說明文字 (有時稱為版面配置項目的說明文字，例如 `ImageItems`、`PageBreakItems` 和 `SectionHeaderItems`)。
`getId()`	`Integer`	取得項目的專屬 ID。
`getIndex()`	`Integer`	取得表單中所有項目中的項目索引。
`getPoints()`	`Integer`	傳回可評分的項目分數。
`getTitle()`	`String`	取得項目的標題 (在 `SectionHeaderItem` 的情況下，有時稱為標頭文字)。
`getType()`	`ItemType`	取得項目的類型，以 `ItemType` 表示。
`isRequired()`	`Boolean`	決定受訪者是否必須回答問題。
`setChoiceValues(values)`	`ListItem`	從字串陣列中設定項目的選項。
`setChoices(choices)`	`ListItem`	為項目設定陣列選項。
`setFeedbackForCorrect(feedback)`	`ListItem`	設定在作答者正確回答問題時，要向他們顯示的意見回饋。
`setFeedbackForIncorrect(feedback)`	`ListItem`	設定作答者回答問題時，系統向他們顯示的意見回饋。
`setHelpText(text)`	`ListItem`	設定項目的說明文字 (對於 `ImageItems`、`PageBreakItems` 和 `SectionHeaderItems` 等版面配置項目，有時稱為說明文字)。
`setPoints(points)`	`ListItem`	設定可評分的項目可獲得的分數。
`setRequired(enabled)`	`ListItem`	設定受訪者是否必須回答問題。
`setTitle(title)`	`ListItem`	設定項目的標題 (在 `SectionHeaderItem` 的情況下，有時稱為標頭文字)。

內容詳盡的說明文件

`createChoice(value)`

建立新選項。

參數

名稱	類型	說明
`value`	`String`	選擇的值，作答者在查看表單時會看到這個值做為標籤

回攻員

Choice - 新選擇

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`createChoice(value, isCorrect)`

建立新選項。

參數

名稱	類型	說明
`value`	`String`	選擇的值，作答者在查看表單時會看到這個值做為標籤
`isCorrect`	`Boolean`	選擇是否為正確答案

回攻員

Choice - 新選擇

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`createChoice(value, navigationItem)`

建立新的選項，其中包含可跳至特定分頁項目的頁面導覽選項。這相當於 createChoice(value, navigationType)，其中 navigationType 設為 FormApp.PageNavigationType.GO_TO_PAGE。使用頁面導覽的選項，無法與不使用頁面導覽的選項，在同一項中合併使用。

只有在受訪者選擇該選項時，系統才會在受訪者完成包含該選項的頁面後，進行頁面導覽。如果受訪者在同一頁面上選擇多個選項，且有頁面導覽操作說明，則只有最後一個導覽選項會生效。頁面導覽對表單的最後一個頁面也沒有任何影響。

參數

名稱	類型	說明
`value`	`String`	選擇的值，作答者在查看表單時會看到這個值做為標籤
`navigationItem`	`PageBreakItem`	要前往的項目

回攻員

Choice - 新選擇

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`createChoice(value, navigationType)`

使用頁面導覽選項建立新選項。使用頁面導覽的選項，無法與未使用頁面導覽的選項，在同一項中合併。

參數

名稱	類型	說明
`value`	`String`	選擇的值，作答者在查看表單時會看到這個值做為標籤
`navigationType`	`PageNavigationType`	選擇的導覽類型

回攻員

Choice - 新選擇

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`createResponse(response)`

為這個清單項目建立新的 ItemResponse。如果 response 引數不符合此項目的有效選項，就會擲回例外狀況。

參數

名稱	類型	說明
`response`	`String`	此清單項目的有效答案

回攻員

ItemResponse：項目回應

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`duplicate()`

建立此項目的副本，並附加至表單結尾。

回攻員

ListItem：這個 ListItem 的複本，用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`getChoices()`

取得項目的所有選項。

回攻員

Choice[]：選項陣列

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`getFeedbackForCorrect()`

在作答者正確回答問題時，傳回要向他們顯示的意見回饋。

回攻員

QuizFeedback - 意見回饋 (如果有的話)。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`getFeedbackForIncorrect()`

當作答者回答問題時，系統會傳回這項回饋。

回攻員

QuizFeedback - 意見回饋 (如果有的話)。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getPoints()`

傳回可評分的項目分數。

回攻員

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

`isRequired()`

決定受訪者是否必須回答問題。

回攻員

Boolean：受訪者是否必須回答問題

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`setChoiceValues(values)`

從字串陣列中設定項目的選項。如果指定的陣列為空白，就會擲回例外狀況。

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoiceValues(['Dogs', 'Cats']);

參數

名稱	類型	說明
`values`	`String[]`	選項值陣列，作答者在查看表單時會看到這些標籤

回攻員

ListItem — 這個 ListItem，用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`setChoices(choices)`

為項目設定陣列選項。如果指定的陣列為空白或包含 null 元素，就會擲回例外狀況。

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoices([item.createChoice('Cats'), item.createChoice('Dogs')]);

參數

名稱	類型	說明
`choices`	`Choice[]`	選擇項目陣列

回攻員

ListItem — 這個 ListItem，用於鏈結

擲回

Error：如果指定的陣列為 null、空白或包含 null 元素

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`setFeedbackForCorrect(feedback)`

設定在作答者正確回答問題時，向他們顯示的意見回饋。

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
// Set "Dogs" as the correct answer to this question.
item.setChoices([
  item.createChoice('Dogs', true),
  item.createChoice('Cats', false),
]);
// Add feedback which will be shown for correct responses; ie "Dogs".
item.setFeedbackForCorrect(
    FormApp.createFeedback().setDisplayText('Dogs rule, cats drool.').build(),
);

參數

名稱	類型	說明
`feedback`	`QuizFeedback`	新的意見回饋。空值會清除意見回饋。

回攻員

ListItem — 這個 ListItem，用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`setFeedbackForIncorrect(feedback)`

設定作答者回答問題時，系統向他們顯示的意見回饋。

參數

名稱	類型	說明
`feedback`	`QuizFeedback`	新的意見回饋

回攻員

ListItem — 這個 ListItem，用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`setHelpText(text)`

設定項目的說明文字 (對於 ImageItems、PageBreakItems 和 SectionHeaderItems 等版面配置項目，有時稱為說明文字)。

參數

名稱	類型	說明
`text`	`String`	新的說明文字

回攻員

ListItem — 這個 ListItem，用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`setPoints(points)`

設定可評分的項目可獲得的分數。新項目的預設值為 0。

參數

名稱	類型	說明
`points`	`Integer`	問題項目的分數

回攻員

ListItem — 這個 ListItem，用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`setRequired(enabled)`

設定受訪者是否必須回答問題。

參數

名稱	類型	說明
`enabled`	`Boolean`	是否要求受訪者回答問題

回攻員

ListItem：目前的項目 (用於鏈結)

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`setTitle(title)`

設定項目的標題 (在 SectionHeaderItem 的情況下，有時稱為標頭文字)。

參數

名稱	類型	說明
`title`	`String`	新的標題或標頭文字

回攻員

ListItem — 這個 ListItem，用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms