レコード開始/停止を任意に制御する

Liveスクリプトが配信条件に合致して配信(配信設定方法はこちら のページをご参照ください。)されると、
ページ遷移を行わない限りそのページのレコード処理を自動で行い続けます。

SPA内でレコード処理を行いたく無いページを除外する場合や、
ページ遷移が伴わないが不必要なコンテンツのレコードを停止したい場合に、
LiveスクリプトのJavaScript APIを通じてレコードの開始/停止を制御することが可能です。

レコード対象外としたいパスを指定して制御する方法

window.__karte_live_optsに除外対象としたいパスを,(半角カンマ)区切りで複数登録できます。
登録されたパスのいずれかがlocation.pathnameと一致した時、レコードを停止します。
※Liveスクリプトはサイト側の処理を一切ブロックせず非同期的に処理を行う仕様の為、パスの切り替えと同一タイミングで制御することはできません。その為、除外対象ページのログが収集されない様、除外ページへ遷移する直前直後のデータもわずかながら除外する可能性があります。

window.__karte_live_opts = {
  denyPaths: '/path/to/deny,/confirm',
};

開始/停止関数を直接コールして制御する方法

上記方法で対応できない場合(ページ遷移を伴わない場合等)、直接Liveスクリプトの関数をコールすることでも制御する事ができます。

Liveスクリプト生成オブジェクト

Liveスクリプトが配信され、正常に起動している場合下記のオブジェクトがページ上に存在します。
非同期でLiveスクリプトが読み込まれる為、ページ描画直後にオブジェクトがまだ生成されていない可能性があります。エラーを防ぐ為、オブジェクトの存在チェックをして関数の実行を行うことを推奨致します。

window.__karte_live

レコードの開始

レコードを開始したい場合は、下記の関数を実行します。
停止されていない状態で実行しても何も起こりません。

window.__karte_live.record();

レコードの停止

レコードを停止したい場合は、下記の関数を実行します。
開始されていない状態で実行しても何も起こりません。

window.__karte_live.stop();

注意事項

  • 当機能でレコードの開始/停止を行うと、別PVとしてレコードが開始されます。(セッションは同一のものになります。セッションの定義は こちら のページをご参照ください)

Updated 8 months ago

レコード開始/停止を任意に制御する


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.