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);
}

クラスの実装

名前概要

メソッド

メソッド戻り値の型概要
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