仮想ページビューで任意のページタイトル・URL を送信する
仮想ページビューとは
USERGRAM のタグは通常、タグが設置されたページの現在のページタイトルと URL を取得して計測サーバへページビューを送信しますが、計測タグをカスタマイズすることで、代わりに 任意のページタイトル・URL をページビューとして送信させることが出来ます。
これを 「仮想ページビュー」と呼び、特殊な計測に活用することができます。 ※任意の URL は実在する必要が無く、 URL として正しい書式の文字列であれば何でも使用可能です。
使いみち
- 実際にはページビューでない行動 (ページ内タブの切り替え等) をページビューとして計測したい
- ページ遷移や URL の変化なしにページが切り替わるサイト (SPA, Ajax など) を計測したい
- ページタイトルや URL を、実際のものとは異なる値で計測したい
- 前処理して、邪魔な文字列を削除する
- 前処理して、任意の文字列を追加情報として与える
- 全く異なる値で計測する
計測タグのカスタマイズ方法
※タグのカスタマイズには JavaScript の知識が必要です。必ず、十分な理解がある方が作業を行うようにしてください。
1. USERGRAMの「共通タグ」を、加工するために「サービス ID」付きで取り出す
タグの取り出し方は こちらの記事を参考にしてください。「サービス ID」付きで取り出すことで、仮想ページビュー用の ページタイトルと URL を組み込む部分がタグに含まれるようになります。
※実際にサービス ID を計測している必要はございません
2. "Usergram Attributes" 部分に、仮想ページビュー用の値を組み込む
取り出したタグには、次のような <!-- Usergram Attributes -->
から始まるサービス ID の組み込み個所が存在します。
<!-- Usergram Attributes --> <script type="text/javascript">window.ugattr = window.ugattr || {}; ugattr['serviceId'] = '●●●●'; // サービス IDで動的に置き換えてください </script> <!-- Usergram Attributes end -->
ここで ugattr
オブジェクトに、任意のページタイトルを documentTitle
、任意の URL を documentLocation
、そして何らかの計測対象サイト内 URL を documentReferrer
という名前で組み込みます。
このとき、ページタイトル・URL いずれかが書き換え不要な場合は 空文字列を指定してください。また、サービス ID が不要な場合、サービス ID の行は削除します。
一方で、 documentReferrer
を空文字列にすると、ページを読み込んだ時のリファラが引き継がれ、仮想ページビューを送信する度に流入が発生するような計測結果を生じ得ます。これを回避し、常に仮想ページビューが回遊扱いとなるよう、 計測対象サイト内の URL を必ず指定 してください。
具体的には次のようなコードになります。
※このコードはサンプルです。そのままコピーして使用せず、実際に組み込む値をお客様サイトに合わせて設計したコードを利用してください。
<!-- Usergram Attributes --> <script type="text/javascript">window.ugattr = window.ugattr || {}; ugattr['documentTitle'] = 'Example.com 仮想ページビュー'; // ここに任意のページタイトルを入力 ※書き換え不要な場合は空文字列(空欄)を指定 ugattr['documentLocation'] = 'https://example.com/virtual?pv=true'; // ここに任意の URL を入力 ※書き換え不要な場合は空文字列(空欄)を指定 ugattr['documentReferrer'] = 'https://example.com/dummy'; // 何らかの計測対象サイト内 URL (空欄 NG) </script> <!-- Usergram Attributes end -->
3.カスタマイズした計測タグを対象のページに設置する
以上で計測タグのカスタマイズは完了です。あとは、カスタマイズしなかった計測タグ後半の <!-- Usergram -->
部分と併せ、計測タグ全体を対象のページに設置すると、そのページの閲覧時に指定したページタイトルと URL でページビューが計測されるようになります。
4.カスタマイズした計測タグの動作確認をする
計測タグを設置したページでの _usergram.png ビーコンリクエストのクエリパラメータの値が、上記で指定した内容となっているかご確認ください。具体的な確認方法については こちら をご覧ください。
計測タグを JavaScript のイベントから呼び出す場合のカスタマイズ方法
前節の手順でカスタマイズした計測タグは、それを設置したページが読み込まれたタイミングで動作するため、 任意のタイミングで動作させるにはもうひと工夫が必要になります。
a. タグマネージャーを使用する場合
お使いのタグマネージャーを用いて、カスタマイズしたタグが目的とするタイミングで動作するように適切な設定を行ってください。この場合、これ以上計測タグに手を加える必要はありません。詳しい設定については、タグマネージャーのベンダーにお問い合わせ下さい。
b. 自前の JavaScript コードから呼び出す場合
計測タグの <!-- Usergram -->
部分前半はUSERGRAMの共通スクリプトを読み込む処理ですので、お客様実装の JavaScript から呼び出す場合には毎回記述する必要はありません。そのページに共通タグを設置していれば共通スクリプトは読み込まれますので、あとは <-- Usergram Attributes -->
部分の処理と <!-- Usergram -->
部分の最後の処理 usergram.push
を呼び出すことで、自前の JavaScript から仮想ページビューを簡単に送信することが出来ます。
具体的には、次のようなコードスニペットへとさらにカスタマイズし、これを必要なタイミングで呼び出してください。最初の行と最後の行が <!-- Usergram -->
部分の処理、それに挟まれた 3 行が <!-- Usergram Attributes -->
部分の処理になっています。
※このコードはサンプルです。そのままコピーして使用せず、この記事の手順に従って自分でカスタマイズしたコードを利用してください。
window.usergram=window.usergram||[],window.ugattr=window.ugattr||{}; ugattr['documentTitle'] = 'Example.com 仮想ページビュー'; // ここに任意のページタイトルを入力 ※書き換え不要な場合は空文字列(空欄)を指定 ugattr['documentLocation'] = 'https://example.com/virtual?pv=true' // ここに任意の URL を入力 ※書き換え不要な場合は空文字列(空欄)を指定 ugattr['documentReferrer'] = 'https://example.com/dummy'; // 何らかの計測対象サイト内 URL (空欄 NG) usergram.push(['send','UgXXXX-1','pv',ugattr]);
注意点
- カスタマイズ後の計測タグやスニペットは、 JavaScript として正しい書式でなければ動作しません
- 任意の URL は、 URL として正しい書式になっている必要があります
- 不正な URL の場合、計測が行われません
- 任意の URL は、計測対象サイトに含まれる URL でなければなりません
- 含まれないURL のページビューは、仮想ページビューであっても計測されません
- 実在しない URL に書き換えて取得した場合、以下のような影響が出る可能性がありますのでご留意ください
- 行動観察画面にて URL クリック時にページが表示されない
- プレビュー画面が表示されない
documentReferrer
の値は 空欄にせず、常に計測対象サイトに含まれる何らかの URL を指定してください- 空欄にした場合、ページを読み込んだ際のリファラが引き継がれ、同じ流入が仮想ページビューの度に繰り返し計測されるような結果を生じ得ます