スクリプトが既存のForm
を開くか、新規作成できるようにします。
// Open a form by ID. var existingForm = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); // Create and open a form. var newForm = FormApp.create('Form Name');
プロパティ
プロパティ | 種類 | 説明 |
---|---|---|
Alignment | Alignment | 画像の配置の種類を列挙します。 |
DestinationType | DestinationType | フォームの回答を保存できるデスティネーションのタイプの列挙。 |
FeedbackType | FeedbackType | Feedbacks 形式の型の列挙型。 |
ItemType | ItemType | Items 形式の型の列挙型。 |
PageNavigationType | PageNavigationType | ページの移動で考えられる動作を列挙します。 |
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
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)
createCheckboxGridValidation()
CheckboxGridItem
での検証の設定に使用できる CheckboxGridValidationBuilder のインスタンスを返します。
リターン
createCheckboxValidation()
createFeedback()
createGridValidation()
createParagraphTextValidation()
ParagraphTextItem
の検証の設定に使用できる ParagraphTextValidationBuilder のインスタンスを返します。
リターン
createTextValidation()
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');
パラメータ
名前 | 型 | 説明 |
---|---|---|
id | String | 開くフォームの 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' );
パラメータ
名前 | 型 | 説明 |
---|---|---|
url | String | 開くフォームの URL |
リターン
Form
- 指定された URL を持つフォーム
例外
Error
- 指定された URL が無効であるか、ユーザーに十分な権限がない場合
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/forms