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傳回 CheckboxAuthenticationBuilder 的執行個體，可用於設定 CheckboxItem 上的驗證程序。
createFeedback()QuizFeedbackBuilder傳回 QuizFeedbackBuilder 的執行個體，可用於在可評分的 Item 上設定意見回饋。
createGridValidation()GridValidationBuilder傳回 GridValidationBuilder 的執行個體，可用於設定 GridItem 上的驗證程序。
createParagraphTextValidation()ParagraphTextValidationBuilder傳回 ParagraphTextVerificationBuilder 的執行個體，可用於設定 ParagraphTextItem 的驗證。
createTextValidation()TextValidationBuilder傳回 TextVerificationBuilder 的執行個體，可用於設定 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新表單的名稱

Return 鍵

Form：新表單

擲回

Error — 如果指定的標題是 null 或空白

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

createCheckboxGridValidation()

傳回 CheckboxGridValidationBuilder 的執行個體，可用於設定 CheckboxGridItem 上的驗證程序。

Return 鍵

CheckboxGridValidationBuilder

createCheckboxValidation()

傳回 CheckboxAuthenticationBuilder 的執行個體，可用於設定 CheckboxItem 上的驗證程序。

Return 鍵

CheckboxValidationBuilder

createFeedback()

傳回 QuizFeedbackBuilder 的執行個體，可用於在可評分的 Item 上設定意見回饋。

Return 鍵

QuizFeedbackBuilder

createGridValidation()

傳回 GridValidationBuilder 的執行個體，可用於設定 GridItem 上的驗證程序。

Return 鍵

GridValidationBuilder

createParagraphTextValidation()

傳回 ParagraphTextVerificationBuilder 的執行個體，可用於設定 ParagraphTextItem 的驗證。

Return 鍵

ParagraphTextValidationBuilder

createTextValidation()

傳回 TextVerificationBuilder 的執行個體，可用於設定 TextItem 的驗證程序。

Return 鍵

TextValidationBuilder

getActiveForm()

傳回指令碼容器繫結的形式。如要與指令碼不受容器限制的表單互動，請改用 openById(id) 或 openByUrl(url)。

// Get the form to which this script is bound.
var form = FormApp.getActiveForm();

Return 鍵

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

Return 鍵

Ui：這個表單的使用者介面環境

openById(id)

傳回含有指定 ID 的 Form。如果 ID 無效，或是使用者沒有開啟表單的權限，便會擲回例外狀況。

// Open a form by ID.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

參數

名稱類型說明
idString要開啟的表單 ID

Return 鍵

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要開啟的表單網址

Return 鍵

Form：包含指定網址的表單

擲回

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

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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