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

Class 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` を作成して返します。
`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()`	`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

`createCheckboxGridValidation()`

CheckboxGridItem の検証に使用できる CheckboxGridValidationBuilder のインスタンスを返します。

戻る

CheckboxGridValidationBuilder

`createCheckboxValidation()`

CheckboxItem の検証に使用できる CheckboxValidationBuilder のインスタンスを返します。

戻る

CheckboxValidationBuilder

`createFeedback()`

採点対象の Item にフィードバックを設定するために使用できる QuizFeedbackBuilder のインスタンスを返します。

戻る

QuizFeedbackBuilder

`createGridValidation()`

GridItem に検証を設定するために使用できる GridValidationBuilder のインスタンスを返します。

戻る

GridValidationBuilder

`createParagraphTextValidation()`

ParagraphTextItem に検証を設定するために使用できる ParagraphTextValidationBuilder のインスタンスを返します。

戻る

ParagraphTextValidationBuilder

`createTextValidation()`

TextItem に検証を設定するために使用できる TextValidationBuilder のインスタンスを返します。

戻る

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