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

Class CheckboxItem

回答者が 1 つ以上のチェックボックスを選択できる質問項目と、オプションの「その他」フィールド。アイテムには Form からアクセスまたは作成できます。これらの項目は、クイズで使用すると自動的に採点されます。

// Open a form by ID and add a new checkbox item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const 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);

メソッド

メソッド	戻り値の型	概要
`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 - チェーン用の this 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.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoiceValues(['Dogs', 'Cats']);

パラメータ

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

戻る

CheckboxItem - チェーン用の this 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.
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[]`	選択肢の配列

戻る

CheckboxItem - チェーン用の this 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.
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`	新しいフィードバック。null 値を指定すると、フィードバックがクリアされます。

戻る

CheckboxItem - チェーン用の this CheckboxItem

承認

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

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

`setFeedbackForIncorrect(feedback)`

質問に誤って回答したときに回答者に表示されるフィードバックを設定します。

パラメータ

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

戻る

CheckboxItem - チェーン用の this CheckboxItem

承認

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

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

`setHelpText(text)`

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

パラメータ

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

戻る

CheckboxItem - チェーン用の this CheckboxItem

承認

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

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

`setPoints(points)`

採点対象の項目に割り当てるポイント数を設定します。新規アイテムのデフォルトは 0 です。

パラメータ

名前	型	説明
`points`	`Integer`	問題アイテムの点数

戻る

CheckboxItem - チェーン用の this 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 - チェーン用の this CheckboxItem

承認

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

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

`setValidation(validation)`

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

パラメータ

名前	型	説明
`validation`	`CheckboxValidation`	この項目に適用する CheckboxValidation。

戻る

CheckboxItem - チェーン用の this CheckboxItem

承認

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

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

`showOtherOption(enabled)`

項目に [その他] オプションがあるかどうかを設定します。新しい CheckboxItem または MultipleChoiceItem のデフォルトは false です。

パラメータ

名前	型	説明
`enabled`	`Boolean`	項目に「その他」のオプションがある場合は `true`、ない場合は `false`

戻る

CheckboxItem - チェーン用の this CheckboxItem

承認

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

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