スクリプトが既存の 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 | 画像の配置の種類の列挙型。 |
Destination | Destination | フォームの回答を保存できるリンク先の種類の列挙型。 |
Feedback | Feedback | フォーム Feedbacks のタイプの列挙型。 |
Item | Item | フォーム Items のタイプの列挙。 |
Page | Page | ページの移動で可能な動作を列挙します。 |
Rating | Rating | 評価アイコンの種類の列挙型 Rating |
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
create(title) | Form | 新しい Form を作成して返します。 |
create(title, isPublished) | Form | リクエストされた公開状態の新しい Form を作成して返します。 |
create | Checkbox | Checkbox の検証に使用できる CheckboxGridValidationBuilder のインスタンスを返します。 |
create | Checkbox | Checkbox の検証に使用できる CheckboxValidationBuilder のインスタンスを返します。 |
create | Quiz | 採点対象の Item にフィードバックを設定するために使用できる QuizFeedbackBuilder のインスタンスを返します。 |
create | Grid | Grid の検証に使用できる GridValidationBuilder のインスタンスを返します。 |
create | Paragraph | Paragraph に検証を設定するために使用できる ParagraphTextValidationBuilder のインスタンスを返します。 |
create | Text | Text の検証に使用できる TextValidationBuilder のインスタンスを返します。 |
get | Form | スクリプトがコンテナにバインドされているフォームを返します。 |
get | Ui | フォーム エディタのユーザー インターフェース環境のインスタンスを返します。これにより、スクリプトでメニュー、ダイアログ、サイドバーなどの機能を追加できます。 |
open | Form | 指定された ID の Form を返します。 |
open | Form | 指定された URL の Form を返します。 |
詳細なドキュメント
create(title)
create(title, isPublished)
リクエストされた公開状態の新しい Form
を作成して返します。指定されたタイトルが null
または空の場合、例外をスローします。
// Create, publish and open a form. const form = FormApp.create('Form Name', true);
パラメータ
名前 | 型 | 説明 |
---|---|---|
title | String | 新しいフォームの名前。 |
is | Boolean | フォームを公開するかどうか。 |
戻る
Form
- 新しいフォーム。
例外
Error
- 指定されたタイトルが null
または空の場合
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/forms
createCheckboxGridValidation()
Checkbox
の検証に使用できる CheckboxGridValidationBuilder のインスタンスを返します。
戻る
createCheckboxValidation()
createFeedback()
createGridValidation()
createParagraphTextValidation()
Paragraph
に検証を設定するために使用できる ParagraphTextValidationBuilder のインスタンスを返します。
戻る
createTextValidation()
getActiveForm()
スクリプトがコンテナにバインドされているフォームを返します。スクリプトがコンテナにバインドされていないフォームを操作するには、代わりに open
または open
を使用します。
// 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