このページは Cloud Translation API によって翻訳されました。

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()`	`ItemType`	アイテムのタイプ（`ItemType` として表されます）を取得します。
`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 などのレイアウトアイテムの説明テキスト）を設定します。

パラメータ

名前	型	説明
`text`	`String`	新しいヘルプテキスト

戻る

Item - チェーン用の this Item

承認

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

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

`setTitle(title)`

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

パラメータ

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

戻る

Item - チェーン用の this Item

承認

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

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