Forms API リファレンス

最終更新日： 2025年5月14日

作成対象：

  • 管理者

Forms 2.0 API を使用して操作する主なオブジェクトは 2 つあります。MktoForms2 オブジェクトと Form オブジェクトです。MktoForms2 オブジェクトは、Forms2 機能の上位レベルの公開名前空間であり、Form オブジェクトを作成、読み込み、取得するための関数が含まれています。

MktoForms2 メソッド

メソッド説明パラメーター戻り値
.loadForm(baseUrl, munchkinId, formId, callback)Marketo サーバーからフォーム記述子を読み込み、新しい Form オブジェクトを作成します。baseUrl（文字列） - サブスクリプションの Marketo サーバーインスタンスへの URL未定義
munchkinId（文字列）- サブスクリプションのMunchkin ID
formId（文字列または数値）- 読み込むフォームのフォームバージョン ID（Vid）
callback（オプション）（関数）- 構築された Form オブジェクトが読み込まれ、初期化されたら渡すコールバック関数。
.lightbox(form, opts)Form オブジェクトを含むライトボックススタイルのモーダルダイアログをレンダリングします。form（Form オブジェクト）- ライトボックスにレンダリングする Form オブジェクトのインスタンス。.show() および .hide() メソッドを備えたライトボックスオブジェクト。
opts（オプション）（オブジェクト）- ライトボックスオブジェクトに渡されるオプションのオブジェクト
onSuccess（関数） - フォームを送信した際にトリガーされるコールバック。
closeBtn（ブーリアン） デフォルト true - ライトボックスダイアログに閉じるボタン（X）を表示するかどうかを制御します。
.newForm(formData, callback)フォーム記述子 JS オブジェクトから新しい Form オブジェクトを作成します。すべてのスタイルシートと既知のリード情報が取得され、Form オブジェクトが作成された後に呼び出されるコールバック関数を追加します。formData（フォーム記述子オブジェクト） - Marketo Forms V2 エディターで作成されたフォーム記述子オブジェクト未定義
callback（オプション）（関数）- このコールバックは、Form オブジェクトの新しく作成されたインスタンスである単一の引数で呼び出されます。
.getForm(formId)フォーム識別子で以前に作成された Form オブジェクトを取得しますformId（数値または文字列）- Form Vid の識別子。Form オブジェクト
.allForms()ページ上で以前に作成されたすべての Form オブジェクトの配列を取得します。該当なしForm オブジェクトの配列
.getPageFields()トラッキング目的で関心がある場合のある URL とリファラーからのデータを含む JS オブジェクトを取得します。該当なしオブジェクト
.whenReady(callback)「準備完了」になるページ上の各フォームに対して 1 回だけ呼び出されるコールバックを追加します。準備完了とは、つまり、フォームが存在し、最初にレンダリングされ、最初のコールバックが呼び出されたことです。この関数が呼び出された時点で既に準備が整っているフォームがある場合は、渡されたコールバックがすぐに呼び出されます。callback（関数） - コールバックには、Form オブジェクトという単一の引数が渡されます。MktoForms2 オブジェクト
.onFormRender(callback)ページ上のフォームをレンダリングするたびに呼び出されるコールバックを追加します。フォームは最初に作成した際にレンダリングされ、その後、表示ルールによってフォームの構造が変更されるたびに再度レンダリングされます。callback（関数）- コールバックには、レンダリングしたフォームの Form オブジェクトという単一の引数が渡されます。MktoForms2 オブジェクト
.whenRendered(callback)onFormRender と同様に、フォームをレンダリングするたびに呼び出されるコールバックを追加します。さらに、既にレンダリングしているすべてのフォームに対して、コールバックをすぐに呼び出します。callback（関数） - コールバックには、レンダリングしたフォームの Form オブジェクトという単一の引数が渡されます。