パラメータ付与
機能概要
Googleアナリティクスなどのアクセス解析ツールやMAツールのパラメータなどをリンク先URLに付与することで、
フォームブロック上にリンクを設置する際にパラメータを付与させたり、フォームブロックを配置するページURLの末尾に
指定したクエリパラメータの値をフォームから指定のフィールドに自動登録することができます。
機能仕様
・URL末尾に「?」を付与、?以降のパラメータを記入してください。
1つのURL内に「?」を2つ以上使用できないため、複数のパラメータを付与する場合は「&」でつなぎます。
※サイト内ページリンクの場合、URL末尾の「?」は自動で付与されます。
記述例:https://(アカウント識別名)-(サイト識別名).spiral-site.com/form?name01=xxxxx&name02=yyyyy
・ThymeleafはWHATWGのドキュメントに沿ってエスケープ/アンエスケープ処理を行っています。
WHATWGのドキュメントではセミコロン(;)なしの実体参照も定義しており、
パラメータの記述によっては、文字列を実体参照とみなし、HTMLの特殊文字に変換される場合がございます。
サイト内ページリンクやth:href
、th:title
、th:text
といったTHの属性にパラメータを設定する場合、
パラメータの記述方法がWHATWGのドキュメントに記載の実体参照と衝突する時には、&を&に書き換えてください。
例)パラメータに¶mter
を記載した場合、¶mter
の先頭5文字が実体参照とみなされ、特殊文字¶
に変換されるため、
parameter01=xxxxx&parameter02=yyyyyと記述する。
・ページURL末尾に付与されたクエリパラメータの値を自動登録する対象フォームブロックは登録フォームブロックのみとなります。
・パラメータキーでは以下の制限を設けています。
1) 英数字以外の文字は指定不可。
2) サービスで使用しているキー情報は使用不可。
・レコードアイテムブロックで使われている record
・クリックログインで使われている cl
・パスワード再登録フォームブロックで使われている rp
・認証APIで使われている tid
各ステップのパラメータ付与
SPIRAL ver.2ではページの中にフォームブロックを配置しますが、登録フォーム/更新フォームブロックに限り、
ブロックやブロックのステップ情報を識別するパラメータを自動付与いたします。
これにより、Google Analyticsなどのアクセス解析ツール上で、訪れたページのビュー数などを計測しやすくなり、ページのアクセス解析に役立てます。
パラメータ付与対象ブロック
登録/更新フォームブロックにパラメータが付与されます。
URL表示形式
URLの表示形式は以下の仕様となります。
ページURL?_{[フォーム種別]登録:ifbs, 更新:ufbs}-{フォーム識別名}=s{ステップの順番}_{ステップ表示名} 例)https://pipedbits-corporatesite.spiral-site.com/page1?_ifbs-form1=s1_Step1
※ステップ表示名にはマルチバイト文字が使用可能です。ブラウザのアドレスバー上に表示されるステップ表示名がURLエンコードされるかはブラウザの仕様に依存いたします。
※完了ステップの場合、フォーム識別名以降の表示が=completion
と表示されます。
ページリンクへのパラメータ設定
1.リンク先設定
ブロック一覧から適用させたいフォームブロックを選択、ブロック表示名をクリックします。
ソース設定の場合
ビジュアル設定の場合
2.パラメータ入力
ページリンク追加のモーダルが開きますのでパラメータ付与欄に記載してください。
サイト内ページ
外部ページ
外部ページの場合はURL欄にパラメータ込みのURLを記載してください。
フォームブロックへのパラメータ設定
フォームブロックを配置するページURL末尾に指定したパラメータ値を引き継いで、該当フィールドにフォームからDBへ自動登録する「引用(任意値)」を設定できます。
詳細は自動登録の任意値(URLパラメータ値)引用を参照ください。
※1 パラメータ値にマルチバイト文字が使用される場合、ブラウザ仕様で値がエンコードされるが、自動登録やThymeleafにおいては、デコードされた値として格納します。
※2 URLのリクエストヘッダーは8192byteまで制限されており、制限を超えた場合はページがエラー(414 Request-URI Too Large)になります。
※3 クエリパラメータキーは32文字まで指定可能です。
※4 パラメータ値を格納するフィールドタイプのフォーマットに反する場合、フォームブロックのエラーステップのページが表示されます。
※5 同一キー情報が複数指定している場合、先頭のキー情報のみ参照、先頭のキー情報に紐づくパラメータ値のみ引き継いでフォームからDBへ自動登録いたします。
※6 Thymeleaf上でキー情報を指定することで、ページURL末尾に付与されたパラメータの値をhidden値のvalueとして引き継いでフォームからDBへ自動登録することができます。
登録フォームブロックの入力ステップ画面で、以下のタグを設定します。
<sp:input-field name="f01"></sp:input-field> <input type="hidden" name="変数名" th:value="${getParams['キー情報']}">
※上記sp:input-field
タグ内のname=""
内に指定する値は、パラメータの値を格納するフィールドのname属性を指定してください。
フィールドのname属性は、登録フォームブロック>入力ステップ>フィールド一覧から確認することができます。
※上記input
タグ内のth:value
内のgetParams['キー情報']
に指定するキー情報は、URL末尾に付与するパラメータキーとなるキーを設定します。