Class 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。
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

---

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