tracker.init

初期化

❗️

tracker(タグv1)のサポート終了について

trackerを利用したタグv1は、サポートの終了を予定しています。詳細は下記をご覧ください。

タグv1のサポート終了のご案内とタグv2移行のお願い | KARTEサポートサイト

tracker オブジェクトを初期化します。

Syntax:

tracker.init(api_key, options);

Arguments:

NameTypeRequiredDefaultDescription
api_keyString-プロジェクトのAPI KEY
optionsObjectオプション
options.domainStringnullCookie の保存ドメインを明示的に指定することができます。サブドメイン毎にCookieを切り分けたい場合に利用します。
options.ktid_checkBooleanfalsekarte.io ドメインに 3rd party cookie (ktid) を発行します
options.spa_modeObjectfalseSPA モードの切り替えが出来ます。

🚧

ktid (3rd party cookie) についての注意

3rd party cookie はブラウザの種類やバージョンによっては利用できません。その場合は 1st party の cookie によってトラッキングされます。

Arguments for SPA:

options.spa_modeに指定できるObjectのプロパティ一覧です。

NameTypeRequiredDefaultRecommended in SPADescription
reset_exclusive_actionBooleantruetrue同時配信NGな接客サービス同士の同時配信制御を、tracker.view()実行時にリセットします。
reset_past_actionsBooleanfalsetrue1つの接客サービスの1PV内での再実行禁止を、tracker.view()実行時にリセットします。
close_actionsBooleanfalsetruetracker.view()実行時に、現在開いているWidgetを閉じます。

📘

SPAにおける仮想的ページ遷移のトラッキング

SPA (Single Page Application) では、通常のページ遷移が行われないため、ページビューイベントの計測とアクションの配信を自分で制御する必要があります。そのための機能が SPA モードです。SPA モードでは tracker.view を明示的に呼ぶ必要があります。

❗️

SPAにおけるwidget実装とメモリリーク

widgetでイベントハンドラの設定を行った場合、widget内のdestroyedイベント発生時のハンドラ内で、設定したイベントハンドラの削除をしてください。削除しない場合、メモリリークする場合があります。

// basic
tracker.init("API_KEY");

// customized
tracker.init("API_KEY", {
  domain: "example.com",
  ktid_check: true,
  spa_mode: {
    reset_exclusive_action: true,
    reset_past_actions: true,
    close_actions: true
  }
});