Class FormApp

FormApp

允许脚本打开现有的 Form 或创建新的 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返回可用于对 GridItem 设置验证的 GridValidationBuilder 实例。
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.
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()

返回可用于对 GridItem 设置验证的 GridValidationBuilder 实例。

弃踢回攻

GridValidationBuilder


createParagraphTextValidation()

返回 ParagraphTextValidationBuilder 的实例,该实例可用于对 ParagraphTextItem 设置验证。

弃踢回攻

ParagraphTextValidationBuilder


createTextValidation()

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

弃踢回攻

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