こちらのドキュメントの内容については、JavaScriptの知識が必要となります。ご了承ください。

カスタムイベントの送信

アクション内で、ユーザーの操作等によって何らかのイベントを送信したい場合は、Script内で下記のように記述ください。

// この例では、'event_name'という名前で、イベントが送信されます
tracker.track('event_name', {
    value1: 'xxx',
    value2: 'yyy'
});

第1引数(’event_name’の箇所)

イベント名を入れてください。半角英数字のみで、先頭は英字のみにしてください。

第2引数

送信するイベントの値を、JavaScriptのオブジェクト形式で指定します。

ただし、message_clickイベントなど、「KARTEが自動的に発生させるイベント」と同じ名称のイベントを指定すると、両イベントが区別できなくなりますので、基本的にイベント名の重複は避けてください。

「KARTEが自動的に発生させるイベント」については、こちらをご覧ください。

第3引数

イベント送信後に何らかの処理を行いたい場合は、コールバック関数が指定できます。

tracker.track('event_name', {
  value1: 'xxx',
  value2: 'yyy'
}, function() {
  // イベント送信後に行いたい処理を記述
});

ウィジェット内のScriptからイベントを送信する

ウィジェットの場合、任意のイベントを発生させるために、widget.track_event()というメソッドが利用できます。

widget.track_event('message_click', {
  url: 'https://...'
});

これにより、計測タグで読み込まれるtrackerの名称を変更した場合にも、正しくイベントトラッキングを行うことができます。