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

Class ListItem

回答者がプルダウンリストから 1 つの選択肢を選択できる質問項目。アイテムには 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`	質問に正しく回答したときに回答者に表示されるフィードバックを返します。
`getFeedbackForIncorrect()`	`QuizFeedback`	質問に誤って回答したときに回答者に表示されるフィードバックを返します。
`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) と同じです。ページナビゲーションを使用する選択肢と、ページナビゲーションを使用しない選択肢を、同じアイテムで組み合わせることはできません。

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

パラメータ

名前	型	説明
`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 - フィードバック（ある場合）。

承認

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

`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 - チェーン用の this 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 - チェーン用の this 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().setDisplayText('Dogs rule, cats drool.').build(),
);

パラメータ

名前	型	説明
`feedback`	`QuizFeedback`	新しいフィードバック。null 値を指定すると、フィードバックがクリアされます。

戻る

ListItem - チェーン用の this ListItem

承認

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

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

`setFeedbackForIncorrect(feedback)`

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

パラメータ

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

戻る

ListItem - チェーン用の this ListItem

承認

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

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

`setHelpText(text)`

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

パラメータ

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

戻る

ListItem - チェーン用の this ListItem

承認

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

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

`setPoints(points)`

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

パラメータ

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

戻る

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

承認

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

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