Class FormApp

FormApp

スクリプトで既存の Form を開いたり、新しい Form を作成したりできます。

// Open a form by ID.
const existingForm = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

// Create and open a form.
const newForm = FormApp.create('Form Name');

プロパティ

プロパティ	タイプ	説明
Alignment	Alignment	画像の配置タイプの列挙。
DestinationType	DestinationType	フォームの回答を保存できる宛先のタイプの列挙。
FeedbackType	FeedbackType	フォームの Feedbacks のタイプの列挙。
ItemType	ItemType	フォームの Items のタイプの列挙。
PageNavigationType	PageNavigationType	ページ移動の動作の列挙。
RatingIconType	RatingIconType	評価アイコンのタイプ RatingIcons の列挙

メソッド

メソッド	戻り値の型	概要
create(title)	Form	新しい Form を作成して返します。
create(title, isPublished)	Form	リクエストされた公開状態の新しい Form を作成して返します。
createCheckboxGridValidation()	CheckboxGridValidationBuilder	CheckboxGridValidationBuilder のインスタンスを返します。このインスタンスを使用して、 CheckboxGridItem に検証を設定できます。
createCheckboxValidation()	CheckboxValidationBuilder	CheckboxValidationBuilder のインスタンスを返します。このインスタンスを使用して、 CheckboxItem に検証を設定できます。
createFeedback()	QuizFeedbackBuilder	QuizFeedbackBuilder のインスタンスを返します。このインスタンスを使用して、採点可能な Item にフィードバックを設定できます。
createGridValidation()	GridValidationBuilder	GridValidationBuilder のインスタンスを返します。このインスタンスを使用して、GridItem に検証を設定できます。
createParagraphTextValidation()	ParagraphTextValidationBuilder	ParagraphTextValidationBuilder のインスタンスを返します。このインスタンスを使用して、 ParagraphTextItem に検証を設定できます。
createTextValidation()	TextValidationBuilder	TextValidationBuilder のインスタンスを返します。このインスタンスを使用して、TextItem に検証を設定できます。
getActiveForm()	Form	スクリプトがコンテナにバインドされているフォームを返します。
getUi()	Ui	フォーム エディタのユーザー インターフェース環境のインスタンスを返します。このインスタンスを使用すると、スクリプトでメニュー、ダイアログ、サイドバーなどの機能を追加できます。
openById(id)	Form	指定された ID の Form を返します。
openByUrl(url)	Form	指定された URL の Form を返します。

詳細なドキュメント

create(title)

新しい Form を作成して返します。指定されたタイトルが null または空の場合、例外をスローします。

// Create and open a form.
const form = FormApp.create('Form Name');

パラメータ

名前	タイプ	説明
title	String	新しいフォームの名前。

戻る

Form - 新しいフォーム。

例外

Error - 指定されたタイトルが null または空の場合

承認

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

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

---

create(title, isPublished)

リクエストされた公開状態の新しい Form を作成して返します。指定されたタイトルが null または空の場合、例外をスローします。

// Create, publish and open a form.
const form = FormApp.create('Form Name', true);

パラメータ

名前	タイプ	説明
title	String	新しいフォームの名前。
isPublished	Boolean	フォームを公開するかどうか。

戻る

Form - 新しいフォーム。

例外

Error - 指定されたタイトルが null または空の場合

承認

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

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

---

createCheckboxGridValidation()

CheckboxGridValidationBuilder のインスタンスを返します。このインスタンスを使用して、CheckboxGridItem に検証を設定できます。

戻る

CheckboxGridValidationBuilder

---

createCheckboxValidation()

CheckboxValidationBuilder のインスタンスを返します。このインスタンスを使用して、CheckboxItem に検証を設定できます。

戻る

CheckboxValidationBuilder

---

createFeedback()

QuizFeedbackBuilder のインスタンスを返します。このインスタンスを使用して、採点可能な Item にフィードバックを設定できます。

戻る

QuizFeedbackBuilder

---

createGridValidation()

GridValidationBuilder のインスタンスを返します。このインスタンスを使用して、GridItem に検証を設定できます。

戻る

GridValidationBuilder

---

createParagraphTextValidation()

ParagraphTextValidationBuilder のインスタンスを返します。このインスタンスを使用して、ParagraphTextItem に検証を設定できます。

戻る

ParagraphTextValidationBuilder

---

createTextValidation()

TextValidationBuilder のインスタンスを返します。このインスタンスを使用して、TextItem に検証を設定できます。

戻る

TextValidationBuilder

---

getActiveForm()

スクリプトがコンテナにバインドされているフォームを返します。スクリプトがコンテナにバインドされていないフォームを操作するには、代わりに openById(id) または openByUrl(url) を使用します。

// Get the form to which this script is bound.
const form = FormApp.getActiveForm();

戻る

Form - スクリプトがバインドされているフォーム。スクリプトがフォームにバインドされていない場合は null

承認

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

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

---

getUi()

フォーム エディタのユーザー インターフェース環境のインスタンスを返します。このインスタンスを使用すると、スクリプトでメニュー、ダイアログ、サイドバーなどの機能を追加できます。スクリプトは、開いているフォーム エディタの 現在のインスタンスの UI（回答者が表示するビューではない）とのみやり取りできます。また、スクリプトが フォームにバインドされている場合に限ります。詳細については、メニューとダイアログ、サイドバーのガイドをご覧ください。

// Add a custom menu to the active form, including a separator and a sub-menu.
function onOpen(e) {
  FormApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(
          FormApp.getUi()
              .createMenu('My sub-menu')
              .addItem('One sub-menu item', 'mySecondFunction')
              .addItem('Another sub-menu item', 'myThirdFunction'),
          )
      .addToUi();
}

戻る

Ui - このフォームのユーザー インターフェース環境のインスタンス

---

openById(id)

指定された ID の Form を返します。ID が無効な場合、またはユーザーにフォームを開く権限がない場合は、例外をスローします。

// Open a form by ID.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

パラメータ

名前	タイプ	説明
id	String	開くフォームの ID

戻る

Form - 指定された ID のフォーム

例外

Error - 指定された ID が無効な場合、またはユーザーに十分な 権限がない場合

承認

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

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

---

openByUrl(url)

指定された URL の Form を返します。URL が無効な場合、またはユーザーにフォームを開く権限がない場合は、例外をスローします。

// Open a form by URL.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit',
);

パラメータ

名前	タイプ	説明
url	String	開くフォームの URL

戻る

Form - 指定された URL のフォーム

例外

Error - 指定された URL が無効な場合、またはユーザーに十分な 権限がない場合

承認

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

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