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');

Properties

プロパティ種類説明
AlignmentAlignment画像調整のタイプの列挙型。
DestinationTypeDestinationTypeフォームの回答を保存できるデスティネーションのタイプの列挙型。
FeedbackTypeFeedbackTypeFeedbacks 型の列挙型。
ItemTypeItemTypeItems 型の列挙型。
PageNavigationTypePageNavigationTypeページを移動するために想定される動作の列挙。

Methods

方法戻り値の型概要
create(title)Form新しい Form を作成して返します。
createCheckboxGridValidation()CheckboxGridValidationBuilderCheckboxGridItem に検証を設定する際に使用できる CheckboxGridValidationBuilder のインスタンスを返します。
createCheckboxValidation()CheckboxValidationBuilderCheckboxItem で検証を設定するために使用できる CheckboxValidationBuilder のインスタンスを返します。
createFeedback()QuizFeedbackBuilderQuizFeedbackBuilder インスタンスを返します。これにより、採点可能な Item にフィードバックを設定できます。
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()

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

戻る

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 とのみやり取りできます。ただし、スクリプトがフォームにバインドされている場合に限ります。詳しくは、メニューおよびダイアログとサイドバーに関するガイドをご覧ください。

// 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