TROCCO Web行動ログ収集SDK - 各種機能
  • 07 May 2024
  • PDF

TROCCO Web行動ログ収集SDK - 各種機能

  • PDF

記事の要約

概要

TROCCO Web行動ログ収集SDKでは、追加でJavaScriptのコードを埋め込んだり、スクリプトを実行することで、以下のことができます。

このページでは、それぞれの方法をサンプルコードを添えて説明します。

イベントトラッキングの追加

以下のJavaScriptのコードを、HTMLファイル内の対象操作を行う箇所に埋め込むことで、ユーザーのイベントを取得できます。
なお、{custom_column_1: 'value1'}の部分については、後述のカスタムカラムの追加を参照ください。

Nanalytics('send','event',{category:<category>,action:<action>,label:<label>,value:<value>,sendPageviewIfSessionExpired:(<boolean>)}, {custom_column_1: 'value1'});

なお、取得したイベントは、転送元 - TROCCO Web行動ログにてイベントログを選択することで転送できます。

コード内の各種パラメーター

必須列に✓がついたパラメーターは、コード内に必ず含める必要があります。

パラメーター名必須データ型説明
actionstringインタラクションの種類
categorystringインタラクションに使用されたオブジェクト
label-stringイベントの分類に使用
value-numberイベントに関連する数値
sendPageviewIfSessionExpired-booleanイベント発火時にセッションの有効期限が切れていた場合、PageViewを送信してセッションを更新するかどうか

コードサンプル

以下は、ユーザーが外部サイトリンクをクリックしたログを取得するコードサンプルです。
なお、string型のパラメーターの値を指定したい場合は、設定値部分をクォーテーションで括ってください。

<a >https://example.com/</a>

カスタムカラムの追加

ページビューログ・イベントログのいずれも、カスタムカラムを設定することで、任意のカラムを取得データに含めることができます。

カスタムカラムの設定数

カスタムカラムは設定できる数に限りがあります。

  • ページビューログの場合:最大10カラムまで
  • イベントログの場合:最大5カラムまで

コードサンプル

以下のコードサンプルにおける、カラム名(custom_column_xの部分)とその値は、適宜編集ください。
値はstring型(文字列)のみ、指定できます。

ページビューログの場合

JavaScriptコードの埋め込みで記載している、埋め込み用JavaScriptのコードのNanalytics('send','pageview');行を、以下のように編集します。

Nanalytics('send','pageview',{custom_column_1: 'value1', custom_column_2: 'value2'});

イベントログの場合

イベントトラッキングの追加で記載しているJavaScriptのコードをベースとします。

<a >https://example.com/</a>

既存設定の変更

以下のJavaScriptのコードを追加で埋め込むことで、TROCCO Web行動ログ収集SDKの内部的な設定を一部変更できます。

Nanalytics('config','<setting_name>',<setting_value>);

変更できる設定項目一覧

通常、以下の設定にはデフォルト値が用いられています。

設定名(setting_name)データ型設定内容デフォルト値
session_expire_msecnumberセッションのタイムアウト時間(ミリ秒)1800000
cookie_prefixstringTROCCO Web行動ログ収集SDKが使用する、Cookieのキー名のプレフィックス__na_
cookie_hoststringデータを保存する際に使用する、Cookieドメイン
ドメインの先頭に.を付与した場合、そのドメイン配下のサブドメイン間で、セッションやユーザーIDが共有されます。
配信先のサイトホスト
customer_idstringサイトの顧客IDなどを保存するためのフィールド
データ型がstringとなることにご留意ください。
-

コードサンプル

JavaScriptコードの埋め込みで記載している、埋め込み用コードのNanalytics('setup',...行とNanalytics('send',...行の間に、以下の行を追加してください。
なお、string型の設定値を変更したい場合は、設定値部分をクォーテーションで括ってください。


スクリプト実行による収集データの取得

TROCCO Web行動ログ収集SDKが収集したデータは、以下のスクリプトを実行することでも取得できます。
Webブラウザの開発者ツールなどで値を確認したい際などにお使いください。

Nanalytics('get',[<callback_function>]);

スクリプトで取得できるデータ一覧

コールバック関数の引数が以下のプロパティ名を持つオブジェクトとなります。
値が存在しない場合は、undefinedとなります。

プロパティ名データ型説明
site_idstringprimeNumberが発行したサイト固有のID
user_idstring1stパーティCookie(サイトドメイン)ベースの一意なID(UUIDv4で生成)
session_idstringセッション内で一意なID(UUIDv4で生成)
browser_heightnumberブラウザの縦幅
browser_widthnumberブラウザの横幅
languagestringブラウザの言語
session_numnumber該当ユーザーの累計セッション回数
session_start_timenumberセッション開始日時
session_channel_urlstringセッション開始時の流入経路URL
mediumstringGoogle Analyticsのutm_mediumに相当する値
sourcestringGoogle Analyticsのutm_sourceに相当する値
campaignstringGoogle Analyticsのutm_campaignに相当する値
keywordstringGoogle Analyticsのutm_termに相当する値
ad_idstringGoogle Adsなどの広告ID
urlstring正規化・デコードされたURL
referer_urlstring正規化・デコードされたリファラーURL
customer_idstring顧客ID
browser_timenumberユーザーのブラウザ時間でPageViewが発生した日時
pv_numnumber該当セッション内における累計PageView回数

コードサンプル

以下は、session_numの値を出力するコードサンプルです。

Nanalytics('get',function(value) { console.log(value.session_num) });

この記事は役に立ちましたか?