Class ListItem

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

回答者がプルダウン リストから選択できるようにするための質問項目です。アイテムへのアクセスや作成には 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')
    ]);

Methods

方法戻り値の型概要
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