Interface Item

項目

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

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

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

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

// Cast the generic item to the text-item class.
if (item.getType() === 'TEXT') {
  const 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項目を段落テキスト項目として返します。
asRatingItem()RatingItemアイテムを評価アイテムとして返します。
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

asRatingItem()

アイテムを評価アイテムとして返します。ItemType がまだ RATING でない場合、ScriptingException をスローします。

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Fetch any item which is of type rating.
const item = form.getItems(FormApp.ItemType.RATING)[0];

// Convert the item to a rating item.
const ratingItem = item.asRatingItem();

戻る

RatingItem - 評価アイテム。

例外

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