アプリケーションにおけるユーザーの行動情報（以降イベント）をKARTEに送信することが可能です。

KARTEに送信したイベントは、解析され統計値として保持されます。
解析済みの統計値は、セグメントやアクション（アプリ内メッセージの表示やプッシュ通知など）のトリガーとして利用することができます。

導入手順

coreモジュールの導入が必要です。
導入手順の詳細については SDKを導入する をご覧ください。

実装手順

イベントを送信するためには、下記の手順でアプリケーションにコードを追加します。

1. SDKのインポート宣言を追加

イベント送信処理を実装するファイルの先頭にインポート宣言を追加します。

import io.karte.android.tracking.Tracker

import io.karte.android.tracking.Tracker;

2. イベント送信するためのコードを追加

KARTEでは用途に応じて、view identify track の3つのメソッドを提供しています。
ここでは、それぞれの利用例について記載します。

📘

イベントの送信に関して

以降の内容については、イベントの送信方法について理解する をご確認頂いてからご覧いただくことを強く推奨いたします。

📘

イベント名やフィールドに関して

イベント送信されるフィールド名や値、またtrackメソッドで指定するイベント名については、命名規則上の制約が存在します。詳細はイベントで使用できないイベント名、フィールド名、フィールド値を御覧ください。

また日付型データや緯度経度の情報を送信する場合には、特別なフォーマットで送信する必要があります。詳細は特別な扱いを受けるフィールドを御覧ください。

各種イベントの送信方法

viewイベントの送信

以下は「会員登録」画面を閲覧したことを表現するイベントを送信する例です。第1引数には、画面を一意に識別するための識別子（view_name）を指定し、第2引数には画面名（title）を指定しています。

送信する内容や実装上の注意点等については、viewイベント送信のベストプラクティスをご確認ください。

※ viewイベントについてはonResume()に実装いただくことを推奨いたします。
詳細は画面の表示イベントを送信するやリファレンスご覧ください。

Tracker.view("signup", "会員登録")

Tracker.view("signup", "会員登録");

また閲覧人数表示を利用する場合には、任意のインターフェースで適宜view_idを付与してください。

identify/attributeイベントの送信

個人情報に類する情報については、identifyイベントとしての送信が推奨されます。identifyイベントの扱いについてはドキュメントをご覧ください。
以下はユーザーのIDを指定してユーザー名を送信する例です。
詳細はユーザーの情報を送信するやリファレンスをご覧ください。

またattributeイベントについては、"attribute"というイベント名のカスタムイベントとして送信してください。

Tracker.identify("ユーザーID", mapOf(
  "name" to "カルテ太郎"
))

Map<String, Object> values = new HashMap<>();
values.put("name", "KARTE太郎");
Tracker.identify("ユーザーID", values);

📘

identify/attributeイベントの送信タイミングに関して

identify/attributeイベントはユーザーを認識するための重要なイベントです。
アプリ起動時にログインしていた場合、会員登録時、送信しているfieldが更新されたといったタイミングで適切に送信してください。
詳細はドキュメントをご覧ください

また送信されるイベント数については一部制限があるため、同じタイミングで複数のfieldを送信する場合は、可能な限り1回の送信で複数fieldをまとめて送信することが推奨されます。

カスタムイベントの送信

以下は「商品をお気に入りに追加」したことを表現するイベントを送信する例です。
詳細は任意の行動イベントを送信するやリファレンスをご覧ください。

Tracker.track("favorite", mapOf(
  "id" to "P00003",
  "name" to "ミネラルウォーター（500ml）",
  "price" to 100
))

Map<String, Object> values = new HashMap<>();
values.put("id", "P00003");
values.put("name", "ミネラルウォーター（500ml）");
values.put("price", 100);
Tracker.track("favorite", values);

動作確認

イベントが正しく送信されたかどうかは、管理画面のイベント画面で確認することが可能です。
イベント画面の使い方については、イベント画面概要 をご覧ください。

トラブルシューティング

イベントの計測ができない場合は、イベント計測までのトラブルシューティングを参考にしてください。