トラッカースクリプト
インストール
ウェブサイトのイベントをトラッキングするためには、ウェブサイトにシンプルなスクリプト（< 2 KB）を挿入するだけで構いません。
スクリプトは以下のようになります：
<script async defer src="https://<あなたの自己ホストドメイン>/tracker.js" data-website-id="xxxxxxxxxxxxx"></script>
このスクリプトコードはTianjiのウェブサイトリストから取得できます。
イベント報告
Tianjiはユーザのクリックイベントを報告するシンプルな方法を提供します。これはユーザがどのアクションを好み、頻繁に使用するかをトラッキングするのに役立ちます。
これはウェブサイト分析における非常に一般的な方法です。Tianjiを使用して、迅速に利用することができます。
基本的な使い方
スクリプトコードをウェブサイトに挿入した後、DOM属性にdata-tianji-eventを追加するだけです。
例：
<button data-tianji-event="submit-login-form">ログイン</button>
これで、ユーザがこのボタンをクリックすると、ダッシュボードに新しいイベントが受信されます。
イベントデータの添付
data-tianji-event-{key}属性を使用してイベントに追加のデータを添付することができます。このパターンに一致する属性はすべて収集され、イベントと共に送信されます。
<button
data-tianji-event="purchase"
data-tianji-event-product="Premium Plan"
data-tianji-event-price="99"
data-tianji-event-currency="USD">
今すぐ購入
</button>
これは、以下のデータを持つpurchaseという名前のイベントを送信します：
{
"product": "Premium Plan",
"price": "99",
"currency": "USD"
}
リンクのクリックをトラッキング
アンカータグ (<a>) にdata-tianji-eventを使用する際、Tianjiはナビゲーションが行われる前にイベントがトラッキングされるように特別に処理します：
<a href="/pricing" data-tianji-event="view-pricing">料金を確認する</a>
内部リンク（新しいタブで開かないもの）の場合、トラッカーは以下を行います：
- デフォルトのナビゲーションを防止
- トラッキングイベントを送信
- トラ ッキングが完了した後、ターゲットURLにナビゲート
外部リンクやtarget="_blank"のリンクの場合、ナビゲーションをブロックせずにイベントがトラッキングされます。
JavaScript API
トラッカースクリプトが読み込まれた後、window.tianjiオブジェクトを使用してプログラムによるイベントトラッキングも可能です。
カスタムイベントのトラッキング
// シンプルなイベントトラッキング
window.tianji.track('button-clicked');
// カスタムデータを持つイベント
window.tianji.track('purchase', {
product: 'Premium Plan',
price: 99,
currency: 'USD'
});
// カスタムペイロードオブジェクトでのトラッキング
window.tianji.track({
website: 'your-website-id',
name: 'custom-event',
data: { key: 'value' }
});
// 関数を使用したトラッキング（現在のページ情報を受け取る）
window.tianji.track((payload) => ({
...payload,
name: 'dynamic-event',
data: { timestamp: Date.now() }
}));
ユーザの識別
トラッキングセッションにユーザ情報を添付できます：
window.tianji.identify({
userId: 'user-123',
email: '[email protected]',
plan: 'premium'
});
この情報は、このユーザからの以降のイベントに関連付けられます。
デフォルトスクリプト名の変更
この機能はバージョン1.7.4+で利用可能です。
開始時に環境変数CUSTOM_TRACKER_SCRIPT_NAMEを使用できます。
例：
CUSTOM_TRACKER_SCRIPT_NAME="my-tracker.js"
その後、トラッカースクリプトは"https://<あなたの自己ホストドメイン>/my-tracker.js"で利用できます。
これは一部の広告ブロッカーを回避するのに役立ちます。
.jsのサフィックスは必要ありません。選択した任意のパスを使用できます。例としてCUSTOM_TRACKER_SCRIPT_NAME="this/is/very/long/path"のように指定することも可能です。
特定のドメインのみをトラッキング
一般的に、トラッカーはウェブサイトが動作しているすべての場所でイベントを報告します。しかし、時にはlocalhostのようなイベントを無視したい場合があります。
Tianjiはトラッカースクリプトに属性を提供しており、それを使用できます。
スクリプトにdata-domainsを追加できます。値はトラッキング対象のルートドメインにすべきです。複数のドメインを指定するには,で区切ります。
<script async defer src="https://<あなたの自己ホストドメイン>/tracker.js" data-website-id="xxxxxxxxxxxxx" data-domains="website.com,www.website.com"></script>
これで、これらのドメインからのイベントのみを見ることができます。