ここでは、KARTEが導入されたWebサイトにおいてタグv1からタグv2に移行する方法について説明します。
タグv2とは?
タグv2の詳細については、下記の記事をご覧ください。
タグv1からタグv2への移行作業の概要
そもそもWebサイトに設置するKARTEのタグには、大きく2種類が存在します。
- 計測タグ
- 設置箇所
- 全てのページで共通のものを設置
- 機能
- KARTEを動作させるためのJavaScriptファイルの読み込み
- 閲覧(view)イベントの取得
- v2への移行手順
- 管理画面から発行される新しい計測タグに差し替える
- 設置箇所
- カスタムイベントタグ(ユーザータグ、viewイベントタグを含む)
- 設置箇所
- 追加のイベントを取得したいページで設置
- 機能
- イベントを取得
- v2への移行手順
- 個々のタグを、v1の記述方法からv2の記述方法に書き換える
- 設置箇所
この2種類のタグ全てについて、最終的にはv1からv2への移行が必要となります。
ただし、後述する「互換タグ付き計測タグv2」を利用すると、暫定的には「計測タグ」の差し替えのみで移行作業が完了し作業コストを軽減することができます。
接客サービスのアクション内に記述されたJavaScriptについては、もしタグv1の記法で記述されたものがあったとしても、タグv2の記法への書き換えは実施しないでください。一部のフィールドが取得できなくなることがあります。
タグv1からタグv2への移行手順
0. 移行前にタグv2で廃止される機能や移行が必要な機能を利用していないか確認する
タグv1からタグv2に移行することで、一部の既存機能が利用できなくなります。
廃止される機能を利用している場合は、事前にそちらの機能の移行が必要になるケースがあります。
下記の記事に記載の機能を利用している場合は、必要に応じて事前の移行作業を実施してください。
タグv2移行時に注意が必要な機能 | スタートガイド / タグ設置・イベント計測 / 概要 | KARTEサポートサイト
1. 暫定的な対応(互換タグを使い計測タグのみ貼り替える)
互換タグを使って、タグv2に移行するために最低限必要な対応について説明します。
「互換タグ」の動作保証期間については、2025年9月末を予定しています、詳細はこちらをご覧ください。
https://support.karte.io/post/13FROpQZRRn7h8jMHEXKjv#4-0
1-1. 計測タグを「互換タグ付き計測タグv2」に貼り替える
「互換タグ(※)付き計測タグv2」を設置することで、カスタムイベントタグの記述をv1からv2のものに書き換えなくても、計測タグを置き換えるだけで暫定的にタグv2に移行することができます。
- グローバルナビゲーション左下の
すべてのメニュー > Tag Manager > タグ設定
から、タグ設定画面を開きます - タグ設定画面で、「互換タグ付き計測タグv2」を発行します
- メニューが表示されない場合は、営業担当までお問い合わせがください
- [タグのカスタマイズ > 「互換タグ付き計測タグv2」を発行する]にチェックを付けます
- 既存の計測タグでtracker名を変更している場合は、変更後のtracker名を入力します
- 次のオプションを利用している場合は、[オプション設定]の対応するオプションをチェックします
- SPAモード
- マルチドメインオプション(マルチドメインモード)
- 非推奨:アプリとクエリパラメータで連携する
- KARTEのネイティブアプリSDKを導入済みで、App - WebView連携において「【非推奨・廃止予定】クエリパラメータを利用した方法」を利用している場合にONにしてください
- 「保存してタグを再発行」をクリックします
- タグ中に
<!-- Start KARTE Compatible Tag -->
という記述が含まれていることを確認します
- Webサイトに設置している既存の計測タグv1を、発行した「互換タグ付き計測タグv2」に貼り替えます
- 事前に動作の検証をしたい場合は、検証環境のWebサイトや一部のページのみ計測タグv2に貼り替えることも可能です
※「互換タグ」とは?
「カスタムイベントタグv1が実行されたときに内部的にカスタムイベントタグv2に変換するスクリプト」を実行するためのタグです。
通常は計測タグv2設置ページに設置するカスタムイベントタグはv2の記法である必要がありますが、「互換タグ付き計測タグv2」を利用すると同一ページで「カスタムイベントタグv1」、「ユーザータグv1」、「viewイベントタグv1」等が実行されても従来通りイベントがKARTEに送られるようになります。
1-2. イベントトラッキングや接客サービスの挙動に問題が無いか確認する
後述する「タグv2移行時の検証について」を参考に、イベントトラッキングや接客サービスの挙動に問題が無いことを確認します。
2. 根本的な対応(カスタムタグもv2に書き替える)
互換タグを使わずに計測タグを移行した場合は、カスタムタグもv2に書き換える必要があります。
接客サービスのアクション内に記述されたJavaScriptについては、もしタグv1の記法で記述されたものがあったとしても、タグv2の記法への書き換えは実施しないでください。一部のフィールドが取得できなくなることがあります。
2-1. カスタムイベントタグをv2に書き換える
計測タグ以外の全てのカスタムイベントタグをタグv2の記法に書き換えることで、全てのタグのバージョンを明示的に統一することができます。
カスタムイベントタグのv2記法については、こちらをご覧ください。
タグv1とタグv2の記述方法や仕様の違い > カスタムイベントタグ | KARTEサポートサイト
書き換えを行う際、こちらのサポートサイトの方法で書き換え対象となるカスタムイベントタグの洗い出しを行ってください。
また、書き換え完了後も同様の方法で対応漏れのカスタムイベントタグがないか、確認をしてください。対応漏れが無いことを確認後、計測タグの移行を行ってください。
なお、移行対象はtrackerというオブジェクトを利用している全てのタグです。
たとえば次のタグも対象に含まれます。
- ユーザータグ(
tracker.user()
。設置方法はこちら) - buyイベントタグ(
tracker.buy()
。設置方法はこちら) - viewイベントタグ(
tracker.view()
)- SPAサイトで利用されるタグ
2-2. 計測タグを「互換タグ無し計測タグv2」に貼り替える
カスタムイベントタグをv2記法に書き換えた後では、「互換タグ」が不要になります。
「互換タグ付き計測タグv2」を設置した場合は、「互換タグ」を抜いた「互換タグ無し計測タグv2(通常の計測タグv2)に貼り替えてください。
- グローバルナビゲーション左下の
すべてのメニュー > Tag Manager > タグ設定
から、タグ設定画面を開きます - タグ設定画面で、「互換タグ無し計測タグv2」を発行します
- [タグのカスタマイズ > 「互換タグ付き計測タグv2」を発行する]のチェックを外します
- その他の設定は変えずに、「保存してタグを再発行」をクリックします
- タグ中に
<!-- Start KARTE Compatible Tag -->
という記述が含まれていないことを確認します
- Webサイトに設置している既存の計測タグv2を、発行した「互換タグ無し計測タグv2」に貼り替えます
なお、設置されている計測タグが「互換タグ付き計測タグv2」か「「互換タグ無し計測タグv2」(通常の計測タグv2)」かを確認する方法は、こちらのサポートサイトにまとめております。上記移行対応後、「互換タグ無し計測タグv2」への移行漏れがないか、ご確認をお願いします。
2-3. イベントトラッキングや接客サービスの挙動に問題が無いか確認する
後述する「タグv2移行時の検証について」を参考に、イベントトラッキングや接客サービスの挙動に問題が無いことを改めて確認します。
タグv2移行時の検証について
検証について、別記事にまとめています。検証時の参考にご覧ください。
KARTE Liveをご利用のお客様へ
セットアップ方法
計測タグv2(互換タグを除く)への移行後、KARTE Liveは設定の変更を行う必要があります。こちらの記事をご参照の上、ご対応をお願いします。
注意点
同一サイトで計測タグv1とv2が混在している場合、コンテキストイベントの一部が正確に計測できません
同一サイトの中でページによって計測タグv1とv2が混在している場合、コンテキストイベントの次に属するイベントが正確に計測できないことがあります。
- 「セッション上のコンテキスト」
- 「行動モード」
なお、「ページ上のコンテキスト」に属するイベントの計測においては問題ありません。
よくある質問
こちらをご覧ください。