Class ListItem

ListItem

回答者がプルダウン リストから回答を 1 つ選択できるようにする質問項目。アイテムは、 Form からアクセスまたは作成できます。

// 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?')
    .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アイテムのヘルプテキスト(ImageItemsPageBreakItemsSectionHeaderItems などのレイアウト アイテムの説明テキストとも呼ばれます)を取得します。
getId()Integerアイテムの一意の識別子を取得します。
getIndex()Integerフォーム内のすべてのアイテム間のアイテムのインデックスを取得します。
getPoints()Integer採点可能なアイテムの点数を返します。
getTitle()Stringアイテムのタイトル(SectionHeaderItem の場合はヘッダー テキスト)を取得します。
getType()ItemTypeItemType として表されるアイテムのタイプを取得します。
isRequired()Boolean回答者が質問に回答する必要があるかどうかを判断します。
setChoiceValues(values)ListItem文字列の配列からアイテムの選択肢を設定します。
setChoices(choices)ListItemアイテムの選択肢の配列を設定します。
setFeedbackForCorrect(feedback)ListItem質問に正しく回答したときに表示されるフィードバックを設定します。
setFeedbackForIncorrect(feedback)ListItem質問に間違った回答があった場合に、回答者に表示されるフィードバックを設定します。
setHelpText(text)ListItemアイテムのヘルプテキスト(ImageItemsPageBreakItemsSectionHeaderItems などのレイアウト アイテムの説明テキストとも呼ばれます)を設定します。
setPoints(points)ListItem採点可能なアイテムの評価点数を設定します。
setRequired(enabled)ListItem回答者が質問に回答する必要があるかどうかを設定します。
setTitle(title)ListItemアイテムのタイトル(SectionHeaderItem の場合はヘッダー テキスト)を設定します。

詳細なドキュメント

createChoice(value)

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

パラメータ

名前説明
valueString選択肢の値(回答者がフォームを表示する際にラベルとして表示される)

戻る

Choice - 新しい選択肢

承認

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

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

createChoice(value, isCorrect)

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

パラメータ

名前説明
valueString選択肢の値(回答者がフォームを表示する際にラベルとして表示される)
isCorrectBoolean正解かどうか

戻る

Choice - 新しい選択肢

承認

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

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

createChoice(value, navigationItem)

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

ページ ナビゲーションは、回答者が次の選択肢を含むページを閲覧した後に行われます。 回答者がそのオプションを選んだ場合に限ります。回答者が複数の選択肢を ページ ナビゲーションの手順を同じページに設定しても、最後のナビゲーション オプションしか作用しません。 ページ ナビゲーションは、フォームの最後のページにも影響を与えません。

パラメータ

名前説明
valueString選択肢の値(回答者がフォームを表示する際にラベルとして表示される)
navigationItemPageBreakItem移動先の項目

戻る

Choice - 新しい選択肢

承認

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

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

createChoice(value, navigationType)

ページ ナビゲーション オプションを含む新しい選択肢を作成します。ページ ナビゲーションを使用する項目は、 同じアイテムに、ページ ナビゲーションを使用しない選択肢を組み合わせたもの。

ページ ナビゲーションは、回答者が次の選択肢を含むページを閲覧した後に行われます。 回答者がそのオプションを選んだ場合に限ります。回答者が複数の選択肢を ページ ナビゲーションの手順を同じページに設定しても、最後のナビゲーション オプションしか作用しません。 ページ ナビゲーションは、フォームの最後のページにも影響を与えません。

パラメータ

名前説明
valueString選択肢の値(回答者がフォームを表示する際にラベルとして表示される)
navigationTypePageNavigationType選択肢のナビゲーション タイプ

戻る

Choice - 新しい選択肢

承認

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

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

createResponse(response)

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

パラメータ

名前説明
responseStringこのリスト項目に対する有効な回答

戻る

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()

アイテムのヘルプテキスト(ImageItemsPageBreakItemsSectionHeaderItems などのレイアウト アイテムの説明テキストとも呼ばれます)を取得します。

戻る

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

パラメータ

名前説明
valuesString[]選択値の配列。回答者がフォームを表示したときにラベルとして表示されます。

戻る

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.
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')
]);

パラメータ

名前説明
choicesChoice[]選択肢の配列

戻る

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.
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());

パラメータ

名前説明
feedbackQuizFeedback新しいフィードバックを作成します。null 値を指定するとフィードバックがクリアされます。

戻る

ListItem - この ListItem(チェーン用)

承認

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

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

setFeedbackForIncorrect(feedback)

質問に間違った回答があった場合に、回答者に表示されるフィードバックを設定します。

パラメータ

名前説明
feedbackQuizFeedback新しいフィードバック

戻る

ListItem - この ListItem(チェーン用)

承認

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

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

setHelpText(text)

アイテムのヘルプテキスト(ImageItemsPageBreakItemsSectionHeaderItems などのレイアウト アイテムの説明テキストとも呼ばれます)を設定します。

パラメータ

名前説明
textString新しいヘルプテキスト

戻る

ListItem - この ListItem(チェーン用)

承認

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

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

setPoints(points)

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

パラメータ

名前説明
pointsInteger質問アイテムが獲得するポイント数

戻る

ListItem - この ListItem(チェーン用)

承認

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

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

setRequired(enabled)

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

パラメータ

名前説明
enabledBoolean回答しなければならないかどうか

戻る

ListItem - 現在のアイテム(チェーン用)

承認

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

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

setTitle(title)

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

パラメータ

名前説明
titleString新しいタイトルまたは見出しのテキスト

戻る

ListItem - この ListItem(チェーン用)

承認

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

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