Class FormApp

FormApp

スクリプトが既存のFormを開くか、新規作成できるようにします。

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

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

プロパティ

プロパティ種類説明
AlignmentAlignment画像の配置の種類を列挙します。
DestinationTypeDestinationTypeフォームの回答を保存できるデスティネーションのタイプの列挙。
FeedbackTypeFeedbackTypeFeedbacks 形式の型の列挙型。
ItemTypeItemTypeItems 形式の型の列挙型。
PageNavigationTypePageNavigationTypeページの移動で考えられる動作を列挙します。

Methods

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

詳細なドキュメント

create(title)

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

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

パラメータ

名前説明
titleString新しいフォームの名前

リターン

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.
var form = FormApp.getActiveForm();

リターン

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

承認

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

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

getUi()

スクリプトがメニュー、ダイアログ、サイドバーなどの機能を追加できるようにするフォーム エディタのユーザー インターフェース環境のインスタンスを返します。スクリプトが UI を操作できるのは、フォーム エディタの現在のインスタンスに対してのみです(回答者に表示されるビューは対象外です)。また、スクリプトがフォームにバインドされている場合にのみ、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.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

パラメータ

名前説明
idString開くフォームの ID

リターン

Form - 指定された ID を持つフォーム

例外

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

承認

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

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

openByUrl(url)

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

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

パラメータ

名前説明
urlString開くフォームの URL

リターン

Form - 指定された URL を持つフォーム

例外

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

承認

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

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