Interface Item

アイテム

すべてのアイテムに共通のプロパティ（タイトルやヘルプテキストなど）を含む汎用のフォーム アイテム。アイテムには Form からアクセスしたり作成したりできます。

タイプ固有のプロパティを操作するには、getType() を使用して、アイテムの ItemType を確認し、asCheckboxItem() などのメソッドを使用して適切なクラスにアイテムをキャストします。

// Create a new form and add a text item.
var form = FormApp.create('Form Name');
form.addTextItem();

// Access the text item as a generic item.
var items = form.getItems();
var item = items[0];

// Cast the generic item to the text-item class.
if (item.getType() == 'TEXT') {
  var textItem = item.asTextItem();
  textItem.setRequired(false);
}

クラスの実装

名前概要

Methods

方法戻り値の型概要
asCheckboxGridItem()CheckboxGridItemアイテムをチェックボックス グリッド アイテムとして返します。
asCheckboxItem()CheckboxItemアイテムをチェックボックス アイテムとして返します。
asDateItem()DateItemアイテムを日付アイテムとして返します。
asDateTimeItem()DateTimeItem日時アイテムとしてアイテムを返します。
asDurationItem()DurationItem期間アイテムとしてアイテムを返します。
asGridItem()GridItemアイテムをグリッド アイテムとして返します。
asImageItem()ImageItemアイテムを画像アイテムとして返します。
asListItem()ListItemアイテムをリストアイテムとして返します。
asMultipleChoiceItem()MultipleChoiceItemそのアイテムを多肢選択式で返します。
asPageBreakItem()PageBreakItem改ページ項目としてアイテムを返します。
asParagraphTextItem()ParagraphTextItemアイテムを段落テキスト アイテムとして返します。
asScaleItem()ScaleItemアイテムをスケール アイテムとして返します。
asSectionHeaderItem()SectionHeaderItemセクション ヘッダー アイテムとしてアイテムを返します。
asTextItem()TextItemアイテムをテキスト アイテムとして返します。
asTimeItem()TimeItemアイテムを時間アイテムとして返します。
asVideoItem()VideoItemアイテムを動画アイテムとして返します。
duplicate()Itemこのアイテムのコピーを作成し、フォームの末尾に追加します。
getHelpText()Stringアイテムのヘルプテキスト（ImageItems、PageBreakItems、SectionHeaderItems などのレイアウト アイテムの説明テキストとも呼ばれます）を取得します。
getId()Integerアイテムの一意の識別子を取得します。
getIndex()Integerフォーム内のすべてのアイテムの中から、そのアイテムのインデックスを取得します。
getTitle()Stringアイテムのタイトルを取得します（SectionHeaderItem の場合はヘッダー テキストと呼ばれることもあります）。
getType()ItemTypeItemType として表されるアイテムのタイプを取得します。
setHelpText(text)Itemアイテムのヘルプテキスト（ImageItems、PageBreakItems、SectionHeaderItems などのレイアウト アイテムの説明テキストとも呼ばれます）を設定します。
setTitle(title)Itemアイテムのタイトルを設定します（SectionHeaderItem の場合はヘッダー テキストとも呼ばれます）。

詳細なドキュメント

asCheckboxGridItem()

アイテムをチェックボックス グリッド アイテムとして返します。ItemType がまだ CHECKBOX_GRID でない場合は、スクリプト例外をスローします。

戻る

CheckboxGridItem - チェックボックス グリッド アイテム

スロー値

Error - アイテムがチェックボックス グリッド アイテムでない場合

認可

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

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

asCheckboxItem()

アイテムをチェックボックス アイテムとして返します。ItemType がまだ CHECKBOX でない場合は、スクリプト例外をスローします。

戻る

CheckboxItem - チェックボックス アイテム

スロー値

Error - チェックボックス以外のアイテム

認可

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

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

asDateItem()

アイテムを日付アイテムとして返します。ItemType がまだ DATE でない場合は、スクリプト例外をスローします。

戻る

DateItem - 日付項目

スロー値

Error - 日付項目でない場合

認可

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

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

asDateTimeItem()

日時アイテムとしてアイテムを返します。ItemType がまだ DATETIME でない場合は、スクリプト例外をスローします。

戻る

DateTimeItem - 日時アイテム

スロー値

Error - アイテムが日時項目でない場合

認可

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

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

asDurationItem()

期間アイテムとしてアイテムを返します。ItemType がまだ DURATION でない場合は、スクリプト例外をスローします。

戻る

DurationItem - 期間アイテム

スロー値

Error - 期間アイテムでない場合

認可

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

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

asGridItem()

アイテムをグリッド アイテムとして返します。ItemType がまだ GRID でない場合は、スクリプト例外をスローします。

戻る

GridItem - グリッド アイテム。

スロー値

Error - グリッド アイテムでない場合

認可

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

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

asImageItem()

アイテムを画像アイテムとして返します。ItemType がまだ IMAGE でない場合は、スクリプト例外をスローします。

戻る

ImageItem - 画像アイテム

スロー値

Error - 画像アイテムでない場合

asListItem()

アイテムをリストアイテムとして返します。ItemType がまだ LIST でない場合は、スクリプト例外をスローします。

戻る

ListItem - リストアイテム

スロー値

Error - リストアイテムでない場合

認可

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

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

asMultipleChoiceItem()

そのアイテムを多肢選択式で返します。ItemType がまだ MULTIPLE_CHOICE でない場合は、スクリプト例外をスローします。

戻る

MultipleChoiceItem - 多肢選択式

スロー値

Error - 選択式ではないアイテム。

認可

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

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

asPageBreakItem()

改ページ項目としてアイテムを返します。ItemType がまだ PAGE_BREAK でない場合は、スクリプト例外をスローします。

戻る

PageBreakItem - 改ページ

スロー値

Error - 改ページ項目でない場合

認可

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

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

asParagraphTextItem()

アイテムを段落テキスト アイテムとして返します。ItemType がまだ PARAGRAPH_TEXT でない場合は、スクリプト例外をスローします。

戻る

ParagraphTextItem - 段落テキスト項目

スロー値

Error - 段落形式のテキスト アイテムでない場合。

認可

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

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

asScaleItem()

アイテムをスケール アイテムとして返します。ItemType がまだ SCALE でない場合は、スクリプト例外をスローします。

戻る

ScaleItem - スケール アイテム

スロー値

Error - 体重計以外の商品の場合

認可

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

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

asSectionHeaderItem()

セクション ヘッダー アイテムとしてアイテムを返します。ItemType がまだ SECTION_HEADER でない場合は、スクリプト例外をスローします。

戻る

SectionHeaderItem - セクション ヘッダー アイテム

スロー値

Error - セクション ヘッダー以外のアイテム

認可

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

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

asTextItem()

アイテムをテキスト アイテムとして返します。ItemType がまだ TEXT でない場合は、スクリプト例外をスローします。

戻る

TextItem - テキスト アイテム

スロー値

Error - アイテムがテキスト アイテムでない場合

認可

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

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

asTimeItem()

アイテムを時間アイテムとして返します。ItemType がまだ TIME でない場合は、スクリプト例外をスローします。

戻る

TimeItem - 時間項目

スロー値

Error - 商品が時間項目でない場合

認可

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

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

asVideoItem()

アイテムを動画アイテムとして返します。ItemType がまだ VIDEO でない場合は、スクリプト例外をスローします。

戻る

VideoItem - 動画アイテム。

スロー値

Error - 動画アイテムでない場合

duplicate()

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

戻る

Item - この Item の重複（チェーンの場合）

認可

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

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

setHelpText(text)

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

パラメータ

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

戻る

Item - この Item（チェーンの場合）

認可

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

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

setTitle(title)

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

パラメータ

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

戻る

Item - この Item（チェーンの場合）

認可

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

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