Forms API參考
最後更新: 2024年7月20日
建立對象:
- 管理員
使用Forms 2.0 API時,您會與兩個主要物件互動。 MktoForms2
物件與Form
物件。 MktoForms2
物件是Forms2功能的最上層公開可見名稱空間,包含建立、載入及擷取Form物件的函式。
MktoForms2方法
方法 | 說明 | 引數 | 傳回值 |
.loadForm(baseUrl, munchkinId, formId, callback) | 從Marketo伺服器載入表單描述項,並建立新的表單物件。 | baseUrl(String) — 您訂閱的Marketo伺服器執行個體的URL | 未定義 |
munchkinId (字串) — 訂閱的Munchkin ID | |||
formId (字串或數字) — 要載入的表單表單版本ID (Vid) | |||
回呼(選用) (函式) — 回呼函式,在已建構的Form物件載入及初始化後,將其傳遞至。 | |||
.lightbox(表單,選項) | 呈現含有Form物件的燈箱樣式模型對話方塊。 | form (Form Object) — 您要在Lightbox中演算的Form物件例項。 | 含有.show()和.hide()方法的燈箱物件。 |
opts (選用)(物件) — 傳遞至Lightbox物件的選項物件 | |||
onSuccess(Function) — 在提交表單時觸發的回呼。 | |||
closeBtn(Boolean)預設true — 控制燈箱對話方塊上是否顯示關閉按鈕(X)。 | |||
.newForm(formData, callback) | 從表單描述項JS物件建立新的表單物件。 新增回呼函式,在擷取所有樣式表和已知潛在客戶資訊並建立表單物件後,呼叫此函式。 | formData (表單描述元物件) — 表單描述元物件,由Marketo Forms V2編輯器建立 | 未定義 |
callback (選用)(函式) — 此callback是使用單一引數來呼叫,此引數是Form物件新建立的例項。 | |||
.getForm(formId) | 透過表單識別碼取得先前建立的表單物件 | formId (數字或字串) — 表單Vid識別碼。 | 表單物件 |
.allForms() | 擷取先前已在頁面上建構的所有表單物件的陣列。 | 不適用 | 表單物件的陣列 |
.getPageFields() | 從URL和反向連結取得包含資料的JS物件,這些資料可能會對追蹤目的有所幫助。 | 不適用 | 物件 |
.whenReady(回撥) | 針對頁面上「準備就緒」的每個表單新增一次呼叫的回呼。 整備是指表單存在、最初已轉譯且已呼叫其初始回呼。 如果呼叫此函式時已經有就緒的表單,則會立即呼叫傳遞的回呼。 | callback(Function) — 會傳遞單一引數(表單物件)作為回呼。 | MktoForms2物件 |
.onFormRender(callback) | 新增每次頁面上任何表單轉譯時都會呼叫的回呼。 Forms會在最初建立時轉譯,然後每次可見性規則變更表單結構時都進行轉譯。 | callback (函式) — 會傳遞單一引數(已轉譯之表單的表單物件)。 | MktoForms2物件 |
.whenRendered(callback) | 就像onFormRender一樣,這會新增每次呈現表單時呼叫的回呼。 此外,這也會立即呼叫已轉譯之所有表單的回呼。 | callback(Function) — 會傳遞單一引數(已演算表單的表單物件)。 |
表單方法
方法 | 說明 | 引數 | 傳回值 |
.render(formElem) | 轉譯表單物件,傳回jQuery物件以包裝包含表單的表單元素。 如果傳遞formElem,則會以該形式作為表單元素,否則會建立新表單元素。 | formElem (選用) — 要呈現的jQuery物件包裝表單元素。 | 包含已轉譯表單的jQuery物件包裝表單元素。 |
.getId() | 取得表單的識別碼。 | 不適用 | 數字 — 此表單所代表的表單物件識別碼 |
.getFormElem() | 取得已轉譯表單的jQuery包裝表單元素。 | 不適用 | jQuery物件包裝的表單元素;如果表單尚未以render()方法轉譯,則為null。 |
.validate() | 強制表單驗證,醒目提示可能存在的任何錯誤並傳回結果。 不提交表單。 | 不適用 | 布林值 — 如果傳遞的表單上的所有驗證器,則傳回true,否則傳回false。 |
.onValidate(callback) | 新增會在觸發驗證時呼叫的驗證回呼。 | callback(Function) — 在任何驗證發生時都會觸發的回呼。 系統會傳遞一個引數,此布林值會指出驗證是否成功。 | 表單物件 — 與呼叫方法的表單物件相同,以做為鏈結之用。 |
.submit() | 觸發表單的提交事件。 這會從提交流程開始,執行驗證、引發任何onSubmit事件、提交表單,以及在表單提交成功時引發任何onSuccess事件。 | 不適用 | 表單物件 — 與呼叫方法的表單物件相同,以做為鏈結之用。 |
.onSubmit(callback) | 新增在提交表單時呼叫的回呼。 提交開始時,在知道請求是否成功之前,就會觸發此動作。 | callback — 提交表單時將呼叫的函式。 此回呼將傳遞一個引數,即此Form物件。 | 表單物件 — 與呼叫方法的表單物件相同,以做為鏈結之用。 |
.onSuccess(callback) | 新增回呼,此回呼會在表單成功提交後、潛在客戶轉送至後續追蹤頁面之前呼叫。 可用於防止在成功提交後將潛在客戶轉送到後續追蹤頁面。 | callback — 成功提交表單時將呼叫的函式。 此回呼將傳遞兩個引數。 JS物件,其中包含已提交的值和使用者將轉送到的後續頁面的字串URL,如果沒有已設定的後續頁面,則為空字串或空字串。 特殊行為:如果此回呼傳回「false」(使用===測量),則訪客「不會」轉送到後續頁面,「不會」重新載入頁面。 這可讓實作者對後續追蹤URL執行額外處理,或使用JavaScript在頁面上採取行動而非離開頁面。 | 表單物件 — 與呼叫方法的表單物件相同,以做為鏈結之用。 |
.submittable(canSubmit) 也可用為: .submitable(canSubmit) | 取得或設定是否可提交表單。 如果呼叫時沒有引數,它會取得值;如果呼叫時有一個引數,則會設定值。這可用來防止表單提交,同時必須符合一般表單之外的其他條件。 | canSubmit (選用)(布林值) — 將表單設為可提交或不可提交。 | 布林值或表單物件 — 如果呼叫時沒有引數,會傳回布林值,指出表單是否可提交。 若以一個引數呼叫,會傳回此表單物件以供鏈結之用。 |
.allFieldsFilled() | 如果表單中的所有欄位都設定了非空白值,則傳回true。 | 不適用 | 布林值 — 如果所有欄位都有非空白/空白/未設定/null值,則為True,否則為false。 |
.setValues(vals) | 在表單中的一或多個欄位上設定值。 | vals - JS物件。 對於物件中的每個索引鍵/值組,名為key的表單欄位將設定為value。 | 未定義 |
.getValues() | 取得表單中所有欄位的所有值。 | 不適用 | 物件 — JS物件包含索引鍵/值配對,代表表單中欄位的名稱和值。 |
.addHiddenFields(values) | 在表單中新增輸入type=hidden欄位。 | values - JS物件,包含索引鍵/值配對,代表要新增至表單的隱藏欄位名稱和值。 | 未定義 |
.vals(values) | jQuery樣式.vals() setter/getter。 如果呼叫時沒有引數,則等同於呼叫getValues()。 若以一個引數呼叫,則等於呼叫setValues() | 值(選用) — 物件 | 未定義 |
.showErrorMessage(msg, elem) | 顯示錯誤訊息,指向專案。 | msg (HTML字串) — 包含您要顯示之錯誤文字的字串。 | 表單物件 — 此表單物件,用於鏈結。 |
elem (選用)(jQuery物件) — 要指向的錯誤元素。 如果未設定,則會使用表單的提交按鈕。 |
recommendation-more-help
bb269a6d-047a-4bf7-9acd-23ad9a63dc59