Class FormApp

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

返回 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.
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