Class GridItem

グリッド項目

列と行のグリッドとして表示される質問アイテム。回答者は、一連のラジオボタンから行ごとに 1 つの選択肢を選択できます。アイテムには Form からアクセスまたは作成できます。

// Open a form by ID and add a new grid item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addGridItem();
item.setTitle('Rate your interests')
    .setRows(['Cars', 'Computers', 'Celebrities'])
    .setColumns(['Boring', 'So-so', 'Interesting']);

メソッド

メソッド戻り値の型概要
clearValidation()GridItemこのグリッドアイテムのデータ入力規則をすべて削除します。
createResponse(responses)ItemResponseこのグリッドアイテムの新しい ItemResponse を作成します。
duplicate()GridItemこの項目のコピーを作成して、フォームの末尾に追加します。
getColumns()String[]グリッド内のすべての列の値を取得します。
getHelpText()Stringアイテムのヘルプテキストを取得します（ImageItems、PageBreakItems、SectionHeaderItems などのレイアウト アイテムの説明テキストとも呼ばれます）。
getId()Integerアイテムの一意の識別子を取得します。
getIndex()Integerフォーム内のすべてのアイテムの中で、アイテムのインデックスを取得します。
getRows()String[]グリッド内のすべての行の値を取得します。
getTitle()Stringアイテムのタイトルを取得します（SectionHeaderItem の場合はヘッダー テキストと呼ばれることもあります）。
getType()ItemTypeアイテムのタイプ（ItemType として表されます）を取得します。
isRequired()Boolean回答者が質問に回答する必要があるかどうかを判断します。
setColumns(columns)GridItem値の配列に基づいてグリッドの列を設定します。
setHelpText(text)GridItemアイテムのヘルプテキスト（ImageItems、PageBreakItems、SectionHeaderItems などのレイアウト アイテムの説明テキスト）を設定します。
setRequired(enabled)GridItem回答者が質問に回答する必要があるかどうかを設定します。
setRows(rows)GridItem値の配列に基づいてグリッドの行を設定します。
setTitle(title)GridItemアイテムのタイトル（SectionHeaderItem の場合はヘッダー テキスト）を設定します。
setValidation(validation)GridItemこのグリッドアイテムのデータの入力規則を設定します。

詳細なドキュメント

clearValidation()

このグリッドアイテムのデータ入力規則をすべて削除します。

戻る

GridItem - チェーン用のこのアイテム

承認

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

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

createResponse(responses)

このグリッドアイテムの新しい ItemResponse を作成します。引数 responses は、グリッドの行数と同じ数の値を含む String[] 配列にする必要があります。必須ではないグリッド形式の質問の null 要素は、その行に回答がないことを示します。いずれかの値が有効な選択肢と一致しない場合、例外をスローします。

パラメータ

名前型説明
responsesString[]このグリッドアイテムの有効な回答の配列

戻る

ItemResponse - アイテムの回答

承認

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

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

duplicate()

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

戻る

GridItem - チェーン用にこの GridItem の複製

承認

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

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

getColumns()

グリッド内のすべての列の値を取得します。

戻る

String[] - 列値の配列。回答者はフォームの表示時にラベルとして表示されます。

承認

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

getRows()

グリッド内のすべての行の値を取得します。

戻る

String[] - 行の値の配列。回答者はフォームを表示する際にラベルとして表示されます。

承認

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

setColumns(columns)

値の配列に基づいてグリッドの列を設定します。指定された配列が空の場合、例外をスローします。

パラメータ

名前型説明
columnsString[]列値の配列。回答者はフォームの表示時にラベルとして表示されます。

戻る

GridItem - チェーン用のこのアイテム

例外

Error - 指定された配列が null または空の場合

承認

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

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

setHelpText(text)

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

パラメータ

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

戻る

GridItem - チェーン用の this GridItem

承認

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

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

setRequired(enabled)

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

パラメータ

名前型説明
enabledBoolean回答者が質問に回答する必要があるかどうか

戻る

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

承認

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

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

setRows(rows)

値の配列に基づいてグリッドの行を設定します。指定された配列が空の場合、例外をスローします。

パラメータ

名前型説明
rowsString[]行の値の配列。回答者はフォームの表示時にラベルとして表示されます。

戻る

GridItem - チェーン用のこのアイテム

例外

Error - 指定された配列が null または空の場合

承認

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

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

setTitle(title)

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

パラメータ

名前型説明
titleString新しいタイトルまたはヘッダー テキスト

戻る

GridItem - チェーン用の this GridItem

承認

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

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

setValidation(validation)

このグリッドアイテムのデータの入力規則を設定します。呼び出された require 関数なしで null または検証を渡すと、以前の検証がすべて削除されます。

パラメータ

名前型説明
validationGridValidationこのアイテムに適用する GridValidation。

戻る

GridItem - チェーン用の this GridItem

承認

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

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