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ページ内を移動する際に考えられる動作を列挙したものです。

メソッド

メソッド戻り値の型概要
create(title)Form新しい Form を作成して返します。
createCheckboxGridValidation()CheckboxGridValidationBuilder検証の設定に使用できる CheckboxGridValidationBuilder のインスタンスを返します。 CheckboxGridItem。
createCheckboxValidation()CheckboxValidationBuilder検証の設定に使用できる CheckboxValidationBuilder のインスタンスを返します。 CheckboxItem。
createFeedback()QuizFeedbackBuilder採点可能なアンケートに関するフィードバックの設定に使用できる QuizFeedbackBuilder のインスタンスを返します。 Item。
createGridValidation()GridValidationBuilderGridItem で検証を設定するために使用できる GridValidationBuilder のインスタンスを返します。
createParagraphTextValidation()ParagraphTextValidationBuilder検証の設定に使用できる ParagraphTextValidationBuilder のインスタンスを返します ParagraphTextItem。
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()

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

戻る

CheckboxGridValidationBuilder

createCheckboxValidation()

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

戻る

CheckboxValidationBuilder

createFeedback()

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

戻る

QuizFeedbackBuilder

createGridValidation()

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

戻る

GridValidationBuilder

createParagraphTextValidation()

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

戻る

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()

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

// 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 が無効な場合、または 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 が無効であるか、ユーザーに十分な URL がない場合 権限

承認

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

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