KARTEが導入されたWebサイトにおいてタグv1からタグv2に移行する際の検証について、参考情報をまとめます。

関連記事

前提

タグv2提供の位置付け

タグv2は今後、Webページに設置するKARTEのタグとして標準のものになっていきます。具体的には、次のような提供方針を予定しています。

  • 2022年8月以降にKARTEを利用開始するプロジェクトでは、Webページに設置するタグのバージョンのデフォルトはタグv2とします（実施済み）
  • 一定の移行期間の後、タグv1のサポートは廃止され、タグv2のみがサポートされるようになります
  • これから新規にリリースされる機能の一部は、タグv2が導入されたWebページでしか利用できません

PLAID側で実施した検証

タグv2の移行によって意図したKARTEの利用ができなくなるリスクを最小限に抑えるために、PLAID側では次の取り組みをすでに実施しています。

  • KARTEの代表的な機能の利用に影響が無いことを確認しました
  • 代表的なアクションテンプレートの表示に問題が無いことを確認しました
  • 顧客企業に協力いただき、複数の本番サイトにタグv2を使ってKARTEを新規導入し、KARTE利用に問題が発生しないことを確認しました
  • 顧客企業に協力いただき、複数の本番サイトでタグv1からタグv2への移行を実施し、KARTE利用に問題が発生しないことを確認しました

タグv1とタグv2の技術的な変更点

タグv1からタグv2に移行することで、技術的には次の点が変更になります。

  • Webページ上に読み込まれるKARTEのJS SDKファイルが変更されます
    • タグv1
      • tracker.js
    • タグv2
      • edge.js
  • Webページ上のイベントトラッキングで利用する関数やその内部処理が変更されます
    • タグv1
      • tracker.track(), tracker.user()等
    • タグv2
      • krt()
  • KARTE JavaScript SDKファイル内の「Webページ上のアクション実行（ポップアップの表示等）を担うWidgetモジュール（以下、「Widgetモジュール」）」を呼び出す部分の内部処理が変更されます
    • 参考: Widget APIでアクションをカスタマイズする
    • ただし後方互換性をなるべく担保するため、既存アクションの表示時に利用される「Widgetモジュール」はタグv2（edge.js）でもタグv1（tracker.js）のものを再利用しています

移行によって直接的に影響を受けるKARTEの主な機能

上記の変更により、直接的に影響を受けるKARTEの主な機能は次の通りです。

  • Webページ上からKARTEへのイベントトラッキング
  • KARTEからWebページに対して配信したアクションの表示

検証方法について

概要

タグv2移行時の検証を安全に進めるために、次の手順に従うことを推奨しています。

  • 検証を実施するユーザーのみでタグv2のタグが発火するようにする
    • 問題が起きた場合の切り分けをしやすくするために、まずは計測タグv1を「互換タグ付き計測タグv2」に移行する検証のみを実施するのがおすすめです
  • イベントの発生や接客サービスの配信・表示に問題が起きないことを確認する
  • 問題がなければ、タグv2を発火させる範囲を徐々に広げていく

検証を実施するユーザーのみでタグv2のタグが発火するようにする方法

KARTEプロジェクトのタグが導入されたWebサイトについて、タグv1からタグv2への移行を段階的に実施することができます。たとえば、移行の検証を目的に一時的に次のようなタグ設置状態にすることが可能です。

  • 検証用Webサイトでタグv2を、本番用Webサイトでタグv1を使う
  • 本番用Webサイトの一部のページでタグv2を、その他のページでタグv1を使う

なお、Googleタグマネージャーを利用している場合は、プレビュー機能を利用することで検証ユーザーのみで一時的にタグv2を発火させることができます。

主な検証観点

タグv2設置ページを用意し、十分な検証を実施してください。主な検証観点は、次の通りです。

Webページ上からKARTEへのイベントトラッキング

  • viewイベントが二重で飛んでいないか？
  • カスタムイベントタグで発生させているカスタムイベントが問題なく発生しているか？
  • 各イベントの発生数について、移行前後で大きな変化は無いか？

発生している閲覧イベントがタグv2に切り替わっているかの確認方法

KARTEからWebページに配信したアクションの表示

  • 重要ないくつかの接客サービスについて、表示内容や挙動に問題が無いか？
    • 表示が崩れていないか？
    • 表示位置が変わっていないか？
    • 表示タイミングが変わっていないか？
  • 特に、「Widgetモジュール」はタグv2でもタグv1のものを再利用しているので、アクションを呼び出す部分やアクションを破棄する部分では特に移行の影響を受ける可能性が比較的高くなっています

移行の影響を受けやすい部分

  • 接客サービスのフロントエンドでの出し分け、排他制御
  • アクションからKARTEのイベントを送信する処理
  • アクション自体の表示、非表示、破棄の制御

移行の影響を受けにくい部分

  • 表示中のアクションにおけるスタイルや、ステート変更などの動作

よくある質問

Q. 計測タグv2から発生したviewイベントをKARTE管理画面等から特定することはできますか？

  • 計測タグv2から発生したviewイベントについては、イベントデータの_system.tag_nameというフィールドに"edge"という値が入るようになっています
  • ユーザーストーリー画面から各イベントのデータ詳細を確認することができます

null