Forms API リファレンス

.loadForm （baseUrl, munchkinId, formId, callback）

Marketo サーバーからフォーム記述子を読み込み、新しいフォームオブジェクトを作成します。

baseUrl （String） – 購読用のMarketo サーバーインスタンスの URL

未定義

munchkinId （String） – 購読の Munchkin ID

formId （文字列または数値） – 読み込むフォームのフォームバージョン ID （Vid）

callback （オプション） （Function） – 構築されたフォームオブジェクトが読み込まれて初期化された後に、そのオブジェクトを渡すコールバック関数。

.lightbox （フォーム、オプション）

フォームオブジェクトを含んだライトボックススタイルのモーダルダイアログをレンダリングします。

フォーム（フォームオブジェクト） – ライトボックスでレンダリングするフォームオブジェクトのインスタンス。

.show （） メソッドと.hide （） メソッドを持つ Lightbox オブジェクト

opts （optional）（Object） - Lightbox オブジェクトに渡すオプションのオブジェクト

onSuccess （Function） – フォームが送信されたときにトリガーされるコールバック。

closeBtn （Boolean） default true - ライトボックスダイアログに閉じるボタン（X）を表示するかどうかを制御します。

.newForm （formData, callback）

フォーム記述子 JS オブジェクトから新しいフォームオブジェクトを作成します。 すべてのスタイルシートと既知のリード情報を取得し、フォームオブジェクトを作成したら呼び出されるコールバック関数を追加します。

formData （フォーム記述子オブジェクト） - Marketo Forms V2 エディターで作成されるフォーム記述子オブジェクト

未定義

callback （オプション）（Function） – このコールバックは、1 つの引数（フォームオブジェクトの新しく作成されたインスタンス）で呼び出されます。

.getForm （formId）

フォーム識別子から作成済みのフォームオブジェクトを取得します

formId （数値または文字列） - Form Vid の識別子。

フォームオブジェクト

.allForms （）

ページ上で以前に作成されたすべてのフォームオブジェクトの配列を取得します。

該当なし

フォームオブジェクトの配列

.getPageFields （）

トラッキング目的で関心がある可能性のある URL およびリファラーからのデータを含む JS オブジェクトを取得します。

該当なし

オブジェクト

.whenReady （callback）

「準備完了」になるページ上の各フォームに対して 1 回だけ呼び出されるコールバックを追加します。 準備とは、フォームが存在し、最初にレンダリングされ、最初のコールバックが呼び出されたことを意味します。 この関数が呼び出される時点で準備が整っているフォームが既にある場合、渡されたコールバックが直ちに呼び出されます。

callback （Function） – コールバックには、1 つの引数であるフォームオブジェクトが渡されます。

MktoForms2 オブジェクト

.onFormRender （callback）

ページ上のフォームがレンダリングされるたびに呼び出されるコールバックを追加します。 Formsは最初に作成されたときに、その表示ルールによってフォームの構造が変わるたびに再びレンダリングされます。

callback （関数） – コールバックには、レンダリングされたフォームのフォームオブジェクトである単一の引数が渡されます。

MktoForms2 オブジェクト

.whenRendered （callback）

onFormRender と同様に、フォームがレンダリングされるたびに呼び出されるコールバックを追加します。 さらに、既にレンダリングされたすべてのフォームに対して、すぐにコールバックが呼び出されます。

callback （Function） – コールバックには、レンダリングされたフォームのフォームオブジェクトである単一の引数が渡されます。

.render （formElem）

フォームオブジェクトをレンダリングし、フォームを含むフォーム要素をラップする jQuery オブジェクトを返します。 formElem が渡された場合は、それをフォーム要素として使用します。それ以外の場合は、新しく作成します。

formElem （オプション） – レンダリング先の jQuery オブジェクトでラップされたフォーム要素。

レンダリングされたフォームを含む、jQuery オブジェクトラップされたフォーム要素。

.getId （）

フォームの ID を取得します。

該当なし

数値 – このフォームが表すフォームオブジェクトの ID

.getFormElem （）

レンダリングされたフォームの jQuery でラップされたフォーム要素を取得します。

該当なし

jQuery オブジェクトラップされたフォーム要素、またはフォームがまだ render （） メソッドでレンダリングされていない場合は null。

.validate （）

フォームの検証を強制し、存在する可能性のあるエラーをハイライト表示して結果を返します。 フォームを送信しません。

該当なし

ブール値 – フォーム上のすべてのバリデータが渡された場合は true を返し、それ以外の場合は false を返します。

.onValidate （callback）

検証がトリガーされるたびに呼び出される検証コールバックを追加します。

callback （Function） – 検証が発生するたびにトリガーされるコールバック。 コールバックには、1 つのパラメーター（検証が成功したかどうかを示すブール値）が渡されます。

フォームオブジェクト – メソッドが呼び出されたのと同じフォームオブジェクト（連鎖の目的）。

.submit （）

フォームの送信イベントをトリガーします。 これは、送信フローから開始し、検証を実行し、onSubmit イベントを発生させ、フォームを送信し、フォームの送信が成功した場合に onSuccess イベントを発生させます。

該当なし

フォームオブジェクト – メソッドが呼び出されたのと同じフォームオブジェクト（連鎖の目的）。

.onSubmit （callback）

フォームが送信されたときに呼び出されるコールバックを追加します。 これは、リクエストの成功/失敗がわかる前に、送信が開始されると実行されます。

callback - フォームが送信されたときに呼び出される関数。 このコールバックには、このフォームオブジェクトという 1 つの引数が渡されます。

フォームオブジェクト – メソッドが呼び出されたのと同じフォームオブジェクト（連鎖の目的）。

.onSuccess （callback）

フォームが正常に送信された後、リードがフォローアップページに転送される前に呼び出されるコールバックを追加します。 送信に成功した後に、リードがフォローアップページに転送されるのを防ぐために使用できます。

callback - フォームが正常に送信されたときに呼び出される関数。 このコールバックには 2 つの引数が渡されます。 送信された値と、ユーザーの転送先となるフォローアップページの文字列 URL を含む JS オブジェクト。設定されたフォローアップページがない場合は null または空の文字列。 特別な動作：このコールバックが（===を使用して測定された）「false」を返した場合、訪問者はフォローアップページに転送されず、ページは再読み込みされません。 これにより、実装者は、フォローアップ URL に対して追加の処理を行ったり、ページを離れることなく JavaScript を使用してページに対するアクションを実行したりできます。

フォームオブジェクト – メソッドが呼び出されたのと同じフォームオブジェクト（連鎖の目的）。

.submittable （canSubmit） 次の URL も利用できます。 .submitable （canSubmit）

フォームを送信できるかどうかを取得または設定します。 引数を指定せずに呼び出した場合はその値を取得し、1 つの引数を指定して呼び出した場合はその値を設定します。これを使用すると、通常のフォーム以外の条件を満たす必要がある場合に、フォームが送信されないようにすることができます。

canSubmit （optional）（Boolean） – フォームを送信可能または送信不可能に設定します。

ブール値またはフォームオブジェクト – 引数を指定せずに呼び出した場合、フォームが送信可能かどうかを示すブール値を返します。 1 つの引数を指定して呼び出された場合は、このフォームオブジェクトが連鎖的に返されます。

.allFieldsFilled （）

フォームのすべてのフィールドに空白以外の値が設定されている場合、true を返します。

該当なし

ブール値 – すべてのフィールドに空白以外の値または空の値または未設定の値または null 値がある場合は true、そうでない場合は false を返します。

.setValues （vals）

フォーム内の 1 つ以上のフィールドに値を設定します。

vals - JS オブジェクト。 オブジェクト内のキーと値のペアごとに、key という名前のフォームフィールドが value に設定されます。

未定義

.getValues （）

フォーム内のすべてのフィールドのすべての値を取得します。

該当なし

オブジェクト – フォーム内のフィールドの名前と値を表すキーと値のペアを含む JS オブジェクト。

.addHiddenFields （values）

input type=hidden フィールドをフォームに追加します。

values - フォームに追加する非表示フィールドの名前と値を表すキーと値のペアを含む JS オブジェクト。

未定義

.vals （values）

jQuery スタイル .vals （）の設定/取得 引数を指定せずに呼び出した場合、getValues （）の呼び出しと同じになります。 1 つの引数を指定して呼び出した場合、setValues （）の呼び出しと同じになります

values （optional） – オブジェクト

未定義

.showErrorMessage （msg, elem）

要素を指すエラーメッセージを表示します。

msg （HTMLの文字列） – 表示するエラーのテキストを含む文字列。

フォームオブジェクト – このフォームオブジェクトは、チェーン用です。

elem （オプション）（jQuery オブジェクト） – エラーの参照先の要素。 未設定の場合は、フォームの送信ボタンが使用されます。