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列舉可儲存表單回應的目的地類型。
FeedbackTypeFeedbackTypeFeedbacks 形式的類型列舉。
ItemTypeItemTypeItems 形式的類型列舉。
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傳回指令碼 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');

參數

名稱類型說明
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()

傳回指令碼 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()

傳回表單編輯器使用者介面環境的例項，該環境可讓指令碼新增選單、對話方塊和側欄等功能。指令碼只能在開啟表單編輯器 (而非作答者看到的檢視畫面) 中與 UI 互動，且指令碼僅限繫結至表單時。詳情請參閱「選單」和「對話方塊和側欄」指南。

// 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