ここでは、KARTEが導入されたWebサイトにおいてタグv1からタグv2に移行する方法について説明します。

タグv2とは?

タグv2の詳細については、下記の記事をご覧ください。

タグv2とは? | KARTEサポートサイト

タグv1からタグv2への移行作業の概要

そもそもWebサイトに設置するKARTEのタグには、大きく2種類が存在します。

  • 計測タグ
    • 設置箇所
      • 全てのページで共通のものを設置
    • 機能
      • KARTEを動作させるためのJavaScriptファイルの読み込み
      • 閲覧(view)イベントの取得
    • v2への移行手順
      • 管理画面から発行される新しい計測タグに差し替える
  • カスタムイベントタグ(ユーザータグ、viewイベントタグを含む)
    • 設置箇所
      • 追加のイベントを取得したいページで設置
    • 機能
      • イベントを取得
    • v2への移行手順
      • 個々のタグを、v1の記述方法からv2の記述方法に書き換える

この2種類のタグ全てについて、最終的にはv1からv2への移行が必要となります。

ただし、後述する「互換タグ付き計測タグv2」を利用すると、暫定的には「計測タグ」の差し替えのみで移行作業が完了し作業コストを軽減することができます。

移行前にタグv2で廃止される機能を利用していないか確認する

タグv1からタグv2に移行することで、一部の既存機能が利用できなくなります。
廃止される機能を利用している場合は、事前にそちらの機能の移行が必要になるケースがあります。

  • タグv2で廃止される機能はこちらをご覧ください
  • 事前の移行が必要な機能
    • ウェブチャットv1、v2については、ウェブチャットv3への移行が必要です
      • ウェブチャットを利用する場合はウェブチャットv3をご利用ください
      • ウェブチャットv1からの移行法についてはこちら
      • ウェブチャットv2からの移行法についてはこちら
    • tracker.linkについては、別の手段でリンククリックトラッキングを実現するようタグの改修が必要です
    • tracker.formについては、別の手段でフォームトラッキングを実現するようタグの改修が必要です
    • CNAME Tracking
      • 2022年9月現在、代わりとなる新機能の開発を予定しています。CNAME Trackingの廃止がタグv2への移行の障壁になる場合は、新機能の利用をご検討ください
    • 計測タグの発火を特定ユーザーのみに制限するようなカスタマイズをしている場合、同じ挙動を維持するためには移行時に特別対応が必要です

タグv1からタグv2への移行手順

0. タグv2に移行可能かどうかを確認する

KARTE管理画面上からタグv2の計測タグを発行できるかどうかについては、下記の手順で確認することができます。

  • グローバルナビゲーション左下の[アカウント/設定(アカウント画像)] > [現在のプロジェクト] > [タグ設定]から、タグ設定画面を開きます
  • タグ設定画面のURL形式によって、デフォルトのタグバージョンを判別できます
    • タグv2
      • https://admin.karte.io/edge/settings/tag?project={{PROJECT_ID}}
    • タグv1
      • https://admin.karte.io/p/{{PROJECT_ID}}/tag_settings

タグをv2に移行を実施したいがタグ設定画面がタグv1のままである場合、サポートまでお問い合わせください。

1. 暫定的な対応(互換タグを使い計測タグのみ貼り替える)

互換タグを使って、タグv2に移行するために最低限必要な対応について説明します。

「互換タグ」の動作保証期間については、2025年9月末を予定しています、詳細はこちらをご覧ください。
https://support.karte.io/post/13FROpQZRRn7h8jMHEXKjv#4-0

1-1. 計測タグを「互換タグ付き計測タグv2」に貼り替える

「互換タグ(※)付き計測タグv2」を設置することで、カスタムイベントタグの記述をv1からv2のものに書き換えなくても、計測タグを置き換えるだけで暫定的にタグv2に移行することができます。

  • グローバルナビゲーション左下の[アカウント/設定(アカウント画像)] > [現在のプロジェクト] > [タグ設定]から、タグ設定画面を開きます
  • タグ設定画面で、「互換タグ付き計測タグv2」を発行します
    • メニューが表示されない場合は、営業担当までお問い合わせがください
    • [タグのカスタマイズ > 「互換タグ付き計測タグv2」を発行する]にチェックを付けます
    • 次のオプションを利用している場合は、[オプション設定]の対応するオプションをチェックします
    • 「保存してタグを再発行」をクリックします
    • タグ中に<!-- Start KARTE Compatible Tag -->という記述が含まれていることを確認します

null

  • Webサイトに設置している既存の計測タグv1を、発行した「互換タグ付き計測タグv2」に貼り替えます
    • 事前に動作の検証をしたい場合は、検証環境のWebサイトや一部のページのみ計測タグv2に貼り替えることも可能です

「互換タグ」とは?
「カスタムイベントタグv1が実行されたときに内部的にカスタムイベントタグv2に変換するスクリプト」を実行するためのタグです。
通常は計測タグv2設置ページに設置するカスタムイベントタグはv2の記法である必要がありますが、「互換タグ付き計測タグv2」を利用すると同一ページで「カスタムイベントタグv1」、「ユーザータグv1」、「viewイベントタグv1」等が実行されても従来通りイベントがKARTEに送られるようになります。

1-2. イベントトラッキングや接客サービスの挙動に問題が無いか確認する

後述する「タグv2移行時の検証について」を参考に、イベントトラッキングや接客サービスの挙動に問題が無いことを確認します。

2. 根本的な対応(カスタムタグもv2に書き替える)

互換タグを使わずに計測タグを移行した場合は、カスタムタグも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)に貼り替えることを推奨しています。

  • グローバルナビゲーション左下の[アカウント/設定(アカウント画像)] > [現在のプロジェクト] > [タグ設定]から、タグ設定画面を開きます
  • タグ設定画面で、「互換タグ無し計測タグv2」を発行します
    • [タグのカスタマイズ > 「互換タグ付き計測タグv2」を発行する]のチェックを外します
    • その他の設定は変えずに、「保存してタグを再発行」をクリックします
    • タグ中に<!-- Start KARTE Compatible Tag -->という記述が含まれていないことを確認します
  • Webサイトに設置している既存の計測タグv2を、発行した「互換タグ無し計測タグv2」に貼り替えます

2-3. イベントトラッキングや接客サービスの挙動に問題が無いか確認する

後述する「タグv2移行時の検証について」を参考に、イベントトラッキングや接客サービスの挙動に問題が無いことを改めて確認します。

タグv2移行時の検証について

検証について、別記事にまとめています。検証時の参考にご覧ください。

KARTE Liveをご利用のお客様へ

タグv2(互換タグを除く)でKARTE Liveご利用の場合設定や仕様の変更があります

現状の接客サービスによる録画スクリプトの配信設定で
仕様の変更内容については、計測タグv2でのKARTE Live利用に関するFAQをご確認ください。
ただし、互換タグをご利用の場合は、現状の接客サービスによるスクリプトの設定のままでも変更なくご利用が可能です。

タグv2(互換タグを除く)でのKARTE Liveの設定方法について

計測タグv2が導入されたWebサイトでは、KARTE Liveの録画用スクリプトの配信方法を、接客サービスを使ったスクリプト配信からKARTE管理画面上での「録画スクリプト設定」に移行する必要があります。
「KARTE管理画面上での「録画スクリプト設定」」についての詳細は、下記ドキュメントをご覧ください。
KARTE Live|[計測タグv2]での活用について | KARTEサポートサイト

  • 正しく設定ができているかどうかについては、タグv1からv2への切り替え後に確認してください
  • 設定方法以外のLiveの閲覧方法については変更はありません

注意点

Opt-Inモードへの対応

計測タグv2は、2022年8月現在、「同意を得たユーザー」のみをKARTEの計測対象にするOpt-Inモードに対応していません。
近日中の対応を予定しています。

同一サイトでタグv1とv2が混在している場合、コンテキストイベントの一部が正確に計測できません

同一サイトの中でページによって計測タグv1とv2が混在している場合、コンテキストイベントの次に属するイベントが正確に計測できないことがあります。

  • 「セッション上のコンテキスト」
  • 「行動モード」

なお、「ページ上のコンテキスト」に属するイベントの計測においては問題ありません。

よくある質問

こちらをご覧ください。

タグv2とは? > よくある質問 | KARTEサポートサイト