Class 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可以存储表单回复的目标类型的枚举。
FeedbackTypeFeedbackType类型为 Feedbacks 类型的枚举。
ItemTypeItemType类型为 Items 类型的枚举。
PageNavigationTypePageNavigationType枚举导航页面的可能行为。

方法

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

详细文档

create(title)

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

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

参数

名称类型说明
titleString新表单的名称

返回

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

返回可用于对 TextItem 设置验证结果的 TextValidationBuilder 实例。

返回

TextValidationBuilder


getActiveForm()

返回脚本容器绑定到的表单。如需与脚本没有容器绑定的表单进行交互,请改用 openById(id)openByUrl(url)

// Get the form to which this script is bound.
var 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.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

参数

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

返回

Form - 具有指定 ID 的表单

抛出

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

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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

openByUrl(url)

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

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

参数

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

返回

Form - 包含指定网址的表单

抛出

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

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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