本頁面由 Cloud Translation API 翻譯而成。

Class FormApp

允許指令碼開啟現有的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`	瀏覽頁面可能的行為列舉。

方法

方法	傳回類型	簡短說明
`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`	傳回指令碼的 container-bound 格式。
`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');

參數

名稱	類型	說明
`title`	`String`	新表單的名稱

回攻員

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

傳回指令碼的 container-bound 格式。若要與送出的表單互動指令碼未繫結，請使用 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');

參數

名稱	類型	說明
`id`	`String`	要開啟的表單 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'
    );

參數

名稱	類型	說明
`url`	`String`	要開啟的表單網址

回攻員

Form：含指定網址的表單

擲回

Error：如果指定的網址無效，或使用者權限不足，權限

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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