このページは 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`	アイテムの一意の識別子を取得します。
`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 - チェーン用のこのアイテム

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

`createResponse(responses)`

このチェックボックスグリッドアイテムの新しい ItemResponse を作成します。引数 responses は、チェックボックスグリッド内の入力の数と同じ数の値を含む配列の String[][] 配列にする必要があります。必須ではないチェックボックスグリッドの質問の null 要素は、その行に回答がないことを示します。いずれかの値が有効な選択肢と一致しない場合、例外がスローされます。

パラメータ

名前	型	説明
`responses`	`String[][]`	このチェックボックスグリッドアイテムの有効な回答の配列の配列

戻る

ItemResponse - アイテムの回答

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

`duplicate()`

この項目のコピーを作成して、フォームの末尾に追加します。

戻る

CheckboxGridItem - チェーン用にこの CheckboxGridItem の複製

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

`getColumns()`

グリッド内のすべての列の値を取得します。

戻る

String[] - 列値の配列。回答者はフォームの表示時にラベルとして表示されます。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

`getHelpText()`

アイテムのヘルプテキストを取得します（ImageItems、PageBreakItems、SectionHeaderItems などのレイアウトアイテムの説明テキストとも呼ばれます）。

戻る

String - アイテムのヘルプテキストまたは説明文

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

`getId()`

アイテムの一意の識別子を取得します。

戻る

Integer - アイテムの ID

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

`getIndex()`

フォーム内のすべてのアイテムの中で、アイテムのインデックスを取得します。

戻る

Integer - アイテムのインデックス

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

`getRows()`

グリッド内のすべての行の値を取得します。

戻る

String[] - 行の値の配列。回答者はフォームを表示する際にラベルとして表示されます。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

`getTitle()`

アイテムのタイトルを取得します（SectionHeaderItem の場合はヘッダーテキストと呼ばれることもあります）。

戻る

String - アイテムのタイトルまたはヘッダーテキスト

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

`getType()`

アイテムのタイプ（ItemType として表されます）を取得します。

戻る

ItemType - アイテムのタイプ

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

`isRequired()`

回答者が質問に回答する必要があるかどうかを判断します。

戻る

Boolean - 回答者が質問に回答する必要があるかどうか

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

`setColumns(columns)`

値の配列に基づいてグリッドの列を設定します。指定された配列が空の場合、例外をスローします。

パラメータ

名前	型	説明
`columns`	`String[]`	列値の配列。回答者はフォームの表示時にラベルとして表示されます。

戻る

CheckboxGridItem - チェーン用のこのアイテム

例外

Error - 指定された配列が null または空の場合

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

`setHelpText(text)`

アイテムのヘルプテキスト（ImageItems、PageBreakItems、SectionHeaderItems などのレイアウトアイテムの説明テキスト）を設定します。

パラメータ

名前	型	説明
`text`	`String`	新しいヘルプテキスト

戻る

CheckboxGridItem - チェーン用の this CheckboxGridItem

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

`setRequired(enabled)`

回答者が質問に回答する必要があるかどうかを設定します。

パラメータ

名前	型	説明
`enabled`	`Boolean`	回答者が質問に回答する必要があるかどうか

戻る

CheckboxGridItem - 現在のアイテム（チェーン用）

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

`setRows(rows)`

値の配列に基づいてグリッドの行を設定します。指定された配列が空の場合、例外をスローします。

パラメータ

名前	型	説明
`rows`	`String[]`	行の値の配列。回答者はフォームの表示時にラベルとして表示されます。

戻る

CheckboxGridItem - チェーン用のこのアイテム

例外

Error - 指定された配列が null または空の場合

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

`setTitle(title)`

アイテムのタイトル（SectionHeaderItem の場合はヘッダーテキスト）を設定します。

パラメータ

名前	型	説明
`title`	`String`	新しいタイトルまたはヘッダーテキスト

戻る

CheckboxGridItem - チェーン用の this CheckboxGridItem

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

`setValidation(validation)`

このチェックボックスグリッド項目のデータの入力規則を設定します。呼び出された require 関数なしで null または検証を渡すと、以前の検証がすべて削除されます。

パラメータ

名前	型	説明
`validation`	`CheckboxGridValidation`	このアイテムに適用する CheckboxGridValidation。

戻る

CheckboxGridItem - チェーン用の this CheckboxGridItem

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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