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アイテムのヘルプテキスト(ImageItemsPageBreakItemsSectionHeaderItems などのレイアウト アイテムの説明テキスト)を取得します。
getId()Integerアイテムの一意の識別子を取得します。
getIndex()Integerフォーム内のすべてのアイテムの中でアイテムのインデックスを取得します。
getTitle()Stringアイテムのタイトル(SectionHeaderItem の場合にヘッダー テキストとも呼ばれます)を取得します。
getType()ItemTypeItemType で表されるアイテムのタイプを取得します。
setHelpText(text)Itemアイテムのヘルプテキスト(ImageItemsPageBreakItemsSectionHeaderItems などのレイアウト アイテムの説明テキスト)を設定します。
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()

アイテムのヘルプテキスト(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

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)

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

パラメータ

名前説明
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