このページは Cloud Translation API によって翻訳されました。

Class CheckboxItem

1 つ以上のチェックボックスと任意で「その他」を選択できる質問項目。アイテムには Form からアクセスしたり作成したりできます。テストで使用すると、これらのアイテムは自動的に採点されます。

// Open a form by ID and add a new checkbox item.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var item = form.addCheckboxItem();
item.setTitle('What condiments would you like on your hot dog?')
    .setChoices([
          item.createChoice('Ketchup'),
          item.createChoice('Mustard'),
          item.createChoice('Relish')
    ])
    .showOtherOption(true);

Methods

方法	戻り値の型	概要
`clearValidation()`	`CheckboxItem`	このチェックボックスの項目のデータ検証を削除します。
`createChoice(value)`	`Choice`	新しい選択肢を作成します。
`createChoice(value, isCorrect)`	`Choice`	新しい選択肢を作成します。
`createResponse(responses)`	`ItemResponse`	このチェックボックス項目用に新しい `ItemResponse` を作成します。
`duplicate()`	`CheckboxItem`	このアイテムのコピーを作成し、フォームの末尾に追加します。
`getChoices()`	`Choice[]`	アイテムのすべての選択肢を取得します。
`getFeedbackForCorrect()`	`QuizFeedback`	回答者が質問に正しく回答したときに表示されるフィードバックを返します。
`getFeedbackForIncorrect()`	`QuizFeedback`	回答者が質問に正しく回答しなかった場合に表示されるフィードバックを返します。
`getHelpText()`	`String`	アイテムのヘルプテキスト（`ImageItems`、`PageBreakItems`、`SectionHeaderItems` などのレイアウトアイテムの説明テキストとも呼ばれます）を取得します。
`getId()`	`Integer`	アイテムの一意の識別子を取得します。
`getIndex()`	`Integer`	フォーム内のすべてのアイテムの中から、そのアイテムのインデックスを取得します。
`getPoints()`	`Integer`	採点可能なアイテムの点数を返します。
`getTitle()`	`String`	アイテムのタイトルを取得します（`SectionHeaderItem` の場合はヘッダーテキストと呼ばれることもあります）。
`getType()`	`ItemType`	`ItemType` として表されるアイテムのタイプを取得します。
`hasOtherOption()`	`Boolean`	アイテムに「その他」オプションがあるかどうかを判断します。
`isRequired()`	`Boolean`	回答者が質問に答えなければならないかどうかを決定します。
`setChoiceValues(values)`	`CheckboxItem`	文字列の配列からアイテムの選択を設定します。
`setChoices(choices)`	`CheckboxItem`	項目の選択の配列を設定します。
`setFeedbackForCorrect(feedback)`	`CheckboxItem`	回答者が質問に正しく回答したときに表示するフィードバックを設定します。
`setFeedbackForIncorrect(feedback)`	`CheckboxItem`	回答者が質問に正しく回答しなかったときに表示するフィードバックを設定します。
`setHelpText(text)`	`CheckboxItem`	アイテムのヘルプテキスト（`ImageItems`、`PageBreakItems`、`SectionHeaderItems` などのレイアウトアイテムの説明テキストとも呼ばれます）を設定します。
`setPoints(points)`	`CheckboxItem`	採点可能なアイテムの点数を設定します。
`setRequired(enabled)`	`CheckboxItem`	回答者が質問に答える必要があるかどうかを設定します。
`setTitle(title)`	`CheckboxItem`	アイテムのタイトルを設定します（`SectionHeaderItem` の場合はヘッダーテキストとも呼ばれます）。
`setValidation(validation)`	`CheckboxItem`	このチェックボックスのデータ検証を設定します。
`showOtherOption(enabled)`	`CheckboxItem`	アイテムに「その他」オプションがあるかどうかを指定します。

詳細なドキュメント

`clearValidation()`

このチェックボックスの項目のデータ検証を削除します。

戻る

CheckboxItem - この CheckboxItem（チェーンの場合）

認可

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

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

`createChoice(value)`

新しい選択肢を作成します。

パラメータ

名前	型	説明
`value`	`String`	選択内容の値（回答者がフォームを表示する際にラベルとして表示されます）

戻る

Choice - 新しい選択肢

認可

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

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

`createChoice(value, isCorrect)`

新しい選択肢を作成します。

パラメータ

名前	型	説明
`value`	`String`	選択内容の値（回答者がフォームを表示する際にラベルとして表示されます）
`isCorrect`	`Boolean`	選択が正しかったかどうか

戻る

Choice - 新しい選択肢

認可

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

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

`createResponse(responses)`

このチェックボックス項目用に新しい ItemResponse を作成します。引数 responses は、確認が必要な値を含む String[] 配列です。showOtherOption(enabled) が true に設定されていない限り、この値の有効な選択肢と一致しない値がある場合は例外をスローします。

パラメータ

名前	型	説明
`responses`	`String[]`	この多肢選択式項目の有効な回答の配列

戻る

ItemResponse - アイテムのレスポンス

認可

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

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

`duplicate()`

このアイテムのコピーを作成し、フォームの末尾に追加します。

戻る

CheckboxItem - この CheckboxItem の重複（チェーンの場合）

認可

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

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

`getChoices()`

アイテムのすべての選択肢を取得します。

戻る

Choice[] - 選択肢の配列

認可

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

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

`getFeedbackForCorrect()`

回答者が質問に正しく回答したときに表示されるフィードバックを返します。

戻る

QuizFeedback - フィードバック（ある場合）。

認可

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

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

`getFeedbackForIncorrect()`

回答者が質問に正しく回答しなかった場合に表示されるフィードバックを返します。

戻る

QuizFeedback - フィードバック（ある場合）。

認可

このメソッドを使用するスクリプトには、次の 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

`getPoints()`

採点可能なアイテムの点数を返します。

戻る

Integer - 質問が獲得するポイントの数です。

認可

このメソッドを使用するスクリプトには、次の 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

`hasOtherOption()`

アイテムに「その他」オプションがあるかどうかを判断します。

戻る

Boolean — true商品に「その他」がある場合。false

認可

このメソッドを使用するスクリプトには、次の 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

`setChoiceValues(values)`

文字列の配列からアイテムの選択を設定します。指定された配列が空の場合、例外をスローします。

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

パラメータ

名前	型	説明
`values`	`String[]`	回答者がフォームを表示する際にラベルとして表示される選択値の配列

戻る

CheckboxItem - この CheckboxItem（チェーンの場合）

認可

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

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.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?')
item.setChoices([
    item.createChoice('Cats'),
    item.createChoice('Dogs')
]);

パラメータ

名前	型	説明
`choices`	`Choice[]`	選択肢の配列

戻る

CheckboxItem - この CheckboxItem（チェーンの場合）

スロー値

Error - 指定された配列が null、空、または null 要素である場合。

認可

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

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.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var 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`	新しいフィードバックnull 値を指定すると、フィードバックがクリアされます。

戻る

CheckboxItem - この CheckboxItem（チェーンの場合）

認可

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

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

`setFeedbackForIncorrect(feedback)`

回答者が質問に正しく回答しなかったときに表示するフィードバックを設定します。

パラメータ

名前	型	説明
`feedback`	`QuizFeedback`	新しいフィードバック

戻る

CheckboxItem - この CheckboxItem（チェーンの場合）

認可

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

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

`setHelpText(text)`

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

パラメータ

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

戻る

CheckboxItem - この CheckboxItem（チェーンの場合）

認可

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

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

`setPoints(points)`

採点可能なアイテムの点数を設定します。新しい商品アイテムのデフォルトは 0 です。

パラメータ

名前	型	説明
`points`	`Integer`	質問項目に割り当てる点数

戻る

CheckboxItem - この CheckboxItem（チェーンの場合）

認可

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

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

`setRequired(enabled)`

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

パラメータ

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

戻る

CheckboxItem - 現在の項目（チェーンの場合）

認可

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

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

`setTitle(title)`

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

パラメータ

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

戻る

CheckboxItem - この CheckboxItem（チェーンの場合）

認可

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

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

`setValidation(validation)`

このチェックボックスのデータ検証を設定します。null または検証を必須関数なしで渡すと、以前の検証が削除されます。

パラメータ

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

戻る

CheckboxItem - この CheckboxItem（チェーンの場合）

認可

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

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

`showOtherOption(enabled)`

アイテムに「その他」オプションがあるかどうかを指定します。新しい CheckboxItem または MultipleChoiceItem のデフォルトは false です。

パラメータ

名前	型	説明
`enabled`	`Boolean`	アイテムに「other」（その他）がある場合は `true`、それ以外の場合は `false`

戻る

CheckboxItem - この CheckboxItem（チェーンの場合）

認可

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

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