Class FormApp

FormApp

允许脚本打开现有 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	图片对齐方式的枚举。
DestinationType	DestinationType	可用于存储表单回复的目标位置类型的枚举。
FeedbackType	FeedbackType	Feedbacks 形式的类型的枚举。
ItemType	ItemType	Items 形式的类型的枚举。
PageNavigationType	PageNavigationType	一个枚举，包含可能的网页浏览行为。
RatingIconType	RatingIconType	评分图标类型的枚举 RatingIcons

方法

方法	返回类型	简介
create(title)	Form	创建并返回新的 Form。
create(title, isPublished)	Form	创建并返回处于所请求发布状态的新 Form。
createCheckboxGridValidation()	CheckboxGridValidationBuilder	返回 CheckboxGridValidationBuilder 的实例，该实例可用于对 CheckboxGridItem 设置验证。
createCheckboxValidation()	CheckboxValidationBuilder	返回一个 CheckboxValidationBuilder 实例，该实例可用于对 CheckboxItem 设置验证。
createFeedback()	QuizFeedbackBuilder	返回 QuizFeedbackBuilder 的一个实例，该实例可用于设置可评分 Item 的反馈。
createGridValidation()	GridValidationBuilder	返回 GridValidationBuilder 的一个实例，该实例可用于在 GridItem 上设置验证。
createParagraphTextValidation()	ParagraphTextValidationBuilder	返回 ParagraphTextValidationBuilder 的实例，该实例可用于对 ParagraphTextItem 设置验证。
createTextValidation()	TextValidationBuilder	返回 TextValidationBuilder 的实例，该实例可用于在 TextItem 上设置验证。
getActiveForm()	Form	返回脚本所绑定到的容器。
getUi()	Ui	返回表单编辑器的界面环境实例，该实例允许脚本添加菜单、对话框和边栏等功能。
openById(id)	Form	返回具有指定 ID 的 Form。
openByUrl(url)	Form	返回具有指定网址的 Form。

详细文档

create(title)

创建并返回新的 Form。如果给定的标题为 null 或为空，则会抛出异常。

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

参数

名称	类型	说明
title	String	新表单的名称。

返回

Form - 新姿势。

抛出

Error - 如果给定的标题为 null 或为空

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

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

---

create(title, isPublished)

创建并返回处于所请求发布状态的新 Form。如果给定的标题为 null 或为空，则会抛出异常。

// Create, publish and open a form.
const form = FormApp.create('Form Name', true);

参数

名称	类型	说明
title	String	新表单的名称。
isPublished	Boolean	表单是否应发布。

返回

Form - 新姿势。

抛出

Error - 如果给定的标题为 null 或为空

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

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

---

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

返回脚本所绑定到的容器。如需与未绑定到容器的脚本所对应的表单互动，请改用 openById(id) 或 openByUrl(url)。

// Get the form to which this script is bound.
const form = FormApp.getActiveForm();

返回

Form - 脚本所绑定的表单；如果脚本未绑定到表单，则为 null

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

• 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.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

参数

名称	类型	说明
id	String	要打开的表单的 ID

返回

Form - 具有指定 ID 的表单

抛出

Error - 如果给定的 ID 无效或用户权限不足

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

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

---

openByUrl(url)

返回具有指定网址的 Form。如果网址无效或用户没有打开表单的权限，则抛出异常。

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

参数

名称	类型	说明
url	String	要打开的表单的网址

返回

Form - 具有指定网址的表单

抛出

Error - 如果给定的网址无效或用户权限不足

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

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