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

Class CheckboxGridItem

這項問題項目會以方格格線的形式呈現，讓作答者從一連串核取方塊中，選取每列的多個選項。您可以透過 Form 存取或建立項目。

// Open a form by ID and add a new checkbox grid item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addCheckboxGridItem();
item.setTitle('Where did you celebrate New Years?')
    .setRows(['New York', 'San Francisco', 'London'])
    .setColumns(['2014', '2015', '2016', '2017']);

方法

方法	傳回類型	簡短說明
`clearValidation()`	`CheckboxGridItem`	移除這個格線項目的所有資料驗證。
`createResponse(responses)`	`ItemResponse`	為這個核取方塊格狀項目建立新的 `ItemResponse`。
`duplicate()`	`CheckboxGridItem`	建立此項目的副本，並附加至表單結尾。
`getColumns()`	`String[]`	取得格線中每個資料欄的值。
`getHelpText()`	`String`	取得項目的說明文字 (有時稱為版面配置項目的說明文字，例如 `ImageItems`、`PageBreakItems` 和 `SectionHeaderItems`)。
`getId()`	`Integer`	取得項目的專屬 ID。
`getIndex()`	`Integer`	取得表單中所有項目中的項目索引。
`getRows()`	`String[]`	取得格狀檢視畫面中每個資料列的值。
`getTitle()`	`String`	取得項目的標題 (在 `SectionHeaderItem` 的情況下，有時稱為標頭文字)。
`getType()`	`ItemType`	取得項目的類型，以 `ItemType` 表示。
`isRequired()`	`Boolean`	決定受訪者是否必須回答問題。
`setColumns(columns)`	`CheckboxGridItem`	根據值陣列設定格線的欄。
`setHelpText(text)`	`CheckboxGridItem`	設定項目的說明文字 (對於 `ImageItems`、`PageBreakItems` 和 `SectionHeaderItems` 等版面配置項目，有時稱為說明文字)。
`setRequired(enabled)`	`CheckboxGridItem`	設定受訪者是否必須回答問題。
`setRows(rows)`	`CheckboxGridItem`	根據值陣列設定格狀檢視畫面的資料列。
`setTitle(title)`	`CheckboxGridItem`	設定項目的標題 (在 `SectionHeaderItem` 的情況下，有時稱為標頭文字)。
`setValidation(validation)`	`CheckboxGridItem`	設定核取方塊格線項目的資料驗證。

內容詳盡的說明文件

`clearValidation()`

移除這個格線項目的所有資料驗證。

回攻員

CheckboxGridItem：用於鏈結的項目

授權

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

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

`createResponse(responses)`

為這個核取方塊格狀項目建立新的 ItemResponse。引數 responses 必須是 String[][] 陣列的陣列，其中包含的值數量必須與核取方塊格線中的輸入數量相同。非必要核取方塊格問題的 null 元素表示該列沒有回應。如果任何值不符合有效選項，系統就會擲回例外狀況。

參數

名稱	類型	說明
`responses`	`String[][]`	這個核取方塊格項目的有效答案陣列陣列

回攻員

ItemResponse：項目回應

授權

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

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

`duplicate()`

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

回攻員

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

授權

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

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

`getColumns()`

取得格線中每個資料欄的值。

回攻員

String[]：資料欄值陣列，使用者在查看表單時會看到這些標籤

授權

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

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

`getRows()`

取得格狀檢視畫面中每個資料列的值。

回攻員

String[]：一組資料列值，會在使用者查看表單時顯示為標籤

授權

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

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

`setColumns(columns)`

根據值陣列設定格線的欄。如果指定的陣列為空，就會擲回例外狀況。

參數

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

回攻員

CheckboxGridItem：用於鏈結的項目

擲回

Error：如果指定的陣列為 null 或空白

授權

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

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

`setHelpText(text)`

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

參數

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

回攻員

CheckboxGridItem — 這個 CheckboxGridItem，用於鏈結

授權

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

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

`setRequired(enabled)`

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

參數

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

回攻員

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

授權

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

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

`setRows(rows)`

根據值陣列設定格狀檢視畫面的列。如果指定的陣列為空白，就會擲回例外狀況。

參數

名稱	類型	說明
`rows`	`String[]`	資料列值陣列，作答者在查看表單時會看到這些值做為標籤

回攻員

CheckboxGridItem：用於鏈結的項目

擲回

Error：如果指定的陣列為 null 或空白

授權

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

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

`setTitle(title)`

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

參數

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

回攻員

CheckboxGridItem — 這個 CheckboxGridItem，用於鏈結

授權

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

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

`setValidation(validation)`

設定核取方塊格線項目的資料驗證。傳入空值或未呼叫任何 require 函式的驗證，會移除先前的驗證。

參數

名稱	類型	說明
`validation`	`CheckboxGridValidation`	要套用至此項目的 CheckboxGridValidation。

回攻員

CheckboxGridItem — 這個 CheckboxGridItem，用於鏈結

授權

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

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