Class ListItem

回答者がプルダウンリストから 1 つの選択肢を選択できる質問項目。アイテムには Form からアクセスしたり、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\|null`	質問に正しく回答したときに回答者に表示されるフィードバックを返します。
`getFeedbackForIncorrect()`	`QuizFeedback\|null`	質問に間違って回答したときに回答者に表示されるフィードバックを返します。
`getHelpText()`	`String`	アイテムのヘルプテキストを取得します（`ImageItems`、`PageBreakItems`、`SectionHeaderItems` などのレイアウトアイテムの説明テキストと呼ばれることもあります）。
`getId()`	`Integer`	アイテムの固有識別子を取得します。
`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 - 新しい選択肢

承認

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

`createChoice(value, navigationItem)`

指定された改ページアイテムにジャンプするページナビゲーションオプションを含む新しい選択肢を作成します。これは、navigationType を FormApp.PageNavigationType.GO_TO_PAGE に設定した createChoice(value, navigationType) と同じです。ページナビゲーションを使用する選択肢は、ページナビゲーションを使用しない選択肢と同じアイテム内で組み合わせることはできません。

ページナビゲーションは、回答者がオプションを含むページを完了し、そのオプションを選択した場合にのみ発生します。回答者が同じページでページナビゲーションの手順を含む複数のオプションを選択した場合、最後のナビゲーションオプションのみが有効になります。ページナビゲーションも、フォームの最後のページには影響しません。

アイテムでページナビゲーションを使用すると、ルーティングがハードコードされます。つまり、showOtherOption(true) を同時に使用することはできません。

パラメータ

名前	タイプ	説明
`value`	`String`	選択肢の値。回答者がフォームを表示するときにラベルとして表示される
`navigationItem`	`PageBreakItem`	移動先のアイテム

戻る

Choice - 新しい選択肢

承認

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

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

`createChoice(value, navigationType)`

ページナビゲーションオプションを使用して新しい選択肢を作成します。ページナビゲーションを使用する選択肢は、ページナビゲーションを使用しない選択肢と同じアイテムに組み合わせることはできません。

ページナビゲーションは、回答者がオプションを含むページを完了し、そのオプションを選択した場合にのみ発生します。回答者が同じページでページナビゲーションの手順を含む複数のオプションを選択した場合、最後のナビゲーションオプションのみが有効になります。ページナビゲーションは、フォームの最後のページにも影響しません。

パラメータ

名前	タイプ	説明
`value`	`String`	選択肢の値。回答者がフォームを表示するときにラベルとして表示される
`navigationType`	`PageNavigationType`	選択肢のナビゲーションタイプ

戻る

Choice - 新しい選択肢

承認

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

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

`createResponse(response)`

このリストアイテムの新しい ItemResponse を作成します。response 引数がこのアイテムの有効な選択肢と一致しない場合は、例外をスローします。

パラメータ

名前	タイプ	説明
`response`	`String`	このリスト項目の有効な回答

戻る

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

承認

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

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

`duplicate()`

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

戻る

ListItem - チェーン用のこの ListItem の複製

承認

このメソッドを使用するスクリプトには、次の 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|null - フィードバック（ある場合）。

承認

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

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

`getFeedbackForIncorrect()`

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

戻る

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

承認

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

`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[]`	選択肢の値の配列。回答者がフォームを表示するときにラベルとして表示されます。

戻る

ListItem - チェーン用の ListItem

承認

このメソッドを使用するスクリプトには、次の 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[]`	選択肢の配列

戻る

ListItem - チェーン用の ListItem

例外

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().setText('Dogs rule, cats drool.').build(),
);

パラメータ

名前	タイプ	説明
`feedback`	`QuizFeedback`	新しいフィードバック。null 値はフィードバックをクリアします。

戻る

ListItem - チェーン用の ListItem

承認

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

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

`setFeedbackForIncorrect(feedback)`

質問に不正解だった場合に回答者に表示するフィードバックを設定します。

パラメータ

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

戻る

ListItem - チェーン用の ListItem

承認

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

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

`setHelpText(text)`

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

パラメータ

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

戻る

ListItem - チェーン用の ListItem

承認

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

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

`setPoints(points)`

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

パラメータ

名前	タイプ	説明
`points`	`Integer`	質問項目の点数

戻る

ListItem - チェーン用の ListItem

承認

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

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

`setRequired(enabled)`

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

パラメータ

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

戻る

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

承認

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

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

`setTitle(title)`

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

パラメータ

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

戻る

ListItem - チェーン用の ListItem

承認

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

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

Class ListItem コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

メソッド

詳細なドキュメント

createChoice(value)

パラメータ

戻る

承認

createChoice(value, isCorrect)

パラメータ

戻る

承認

createChoice(value, navigationItem)

パラメータ

戻る

承認

createChoice(value, navigationType)

パラメータ

戻る

承認

createResponse(response)

パラメータ

戻る

承認

duplicate()

戻る

承認

getChoices()

戻る

承認

getFeedbackForCorrect()

戻る

承認

getFeedbackForIncorrect()

戻る

承認

getHelpText()

戻る

承認

getId()

戻る

承認

getIndex()

戻る

承認

getPoints()

戻る

承認

getTitle()

戻る

承認

getType()

戻る

承認

isRequired()

戻る

承認

setChoiceValues(values)

パラメータ

戻る

承認

setChoices(choices)

パラメータ

戻る

例外

承認

setFeedbackForCorrect(feedback)

パラメータ

戻る

承認

setFeedbackForIncorrect(feedback)

パラメータ

戻る

承認

setHelpText(text)

パラメータ

戻る

承認

setPoints(points)

パラメータ

戻る

Class ListItem

`createChoice(value)`

`createChoice(value, isCorrect)`

`createChoice(value, navigationItem)`

`createChoice(value, navigationType)`

`createResponse(response)`

`duplicate()`

`getChoices()`

`getFeedbackForCorrect()`

`getFeedbackForIncorrect()`

`getHelpText()`

`getId()`

`getIndex()`

`getPoints()`

`getTitle()`

`getType()`

`isRequired()`

`setChoiceValues(values)`

`setChoices(choices)`

`setFeedbackForCorrect(feedback)`

`setFeedbackForIncorrect(feedback)`

`setHelpText(text)`

`setPoints(points)`

`setRequired(enabled)`

`setTitle(title)`