uni-app Advanced

ユーザーID設定

SDKインスタンスはランダムの値でユーザーのゲストIDとして付与します。ゲストIDはユーザーがログインする前のユーザー識別IDとして使われます。ただし、事前に注意すべきのは、アカウントIDはユーザー再インストールすると変更されます。

1.1 ゲストID設定

::: Tips

一般的には、ゲストIDを手動設定することは不要で、ユーザー識別ルールを確認した上で、ゲストID設定を行なってください。

:::

独自でゲストIDの管理体制がある場合は、identifyを呼び出して、ゲストIDを設定してください

// set distinct ID as Thinker
ta.identify("Thinker");

現在のゲストIDを取得したい場合は、getDistinctIdを呼び出して取得できます。

//Return distinct ID
let distinctId = ta.getDistinctId();

設定を行う場合は、初期設定する前にこの呼び出しを行ってください

1.2 アカウントID設定

ユーザーログイン時に、Loginを呼び出してアカウントIDを設定できます。TEはアカウントIDをユーザー身分の識別IDとして使われています。一度設定されたアカウントIDはLogoutを呼び出す前に保存されます。Loginを多数呼び出した場合は、その前のアカウントIDを上書きされます。

The login unique identifier of the user, corresponding to the #account_id in data tracking. #Account_id now is TE
ta.login("TE");

この方法ではログインイベントとして送信されません

1.3 アカウントIDをクリア

ユーザーがログアウトイベントを行う前に、Logoutを呼び出して、アカウントIDをクリアすることができます。もう一度Loginを呼び出す前にゲストIDはユーザー身分の識別IDとして使われます。

ta.logout();

ユーザーがアカウントを削除する際にLogoutを呼び出すよう設定してください。

ログアウトイベントとして送信されません。

イベント送信

SDKが初期化設定完了後、データプランに応じて、トラッキングコードを実装し、ユーザーの行動データを収集することができます。一般的には、通常イベント送信は十分収集可能で、実際業務シーンによって、初回・更新可能などの特殊イベント収集することも可能です。

2.1 通常イベント

track を呼び出して、データプランに応じてイベントのプロパティを設定の上、データ送信できます。

例：アイテム購入

ta.track(
  "product_buy", // event name
  { product_name: "アイテム名" } // event properties
);

2.2 初回イベント

初回イベントはあるデバイスもしくはその他分析主体のIDごとで、1回目のみ記録されるイベントとなります。

例えば：あるデバイスのアクティブイベントはそれを使って便利です

ta.trackFirstEvent({
  eventName: "device_activation",
  properties: { key: "value" }
});

もしデバイス以外の主体で初回判断したい場合は、first_check_idで初回イベントカスタムできます

// set the user ID as the first_check_id of the first event to track the first initialization event of the user.
ta.trackFirstEvent({
  eventName: "account_activation",
  firstCheckId: "TA",
  properties: { key: "value" }
});

注意：サーバ側で初回なのかを検証するため、初回イベントはデフォルトで1時間遅延して格納されます。

2.3 更新可能イベント

通常イベントはデータを格納されたら更新不可となりますが、データ更新を行いたい場合は、更新可能イベントを利用してください。更新可能イベントは識別イベントのIDが必要で、作成時はプロパティに入れてください。TEシステムはイベント名とイベントIDを識別対象として更新データを確定します。

// The event property status is 3 after reporting, with the price being 100
ta.trackUpdate({
  eventName: "UPDATABLE_EVENT",
  properties: { status: 3, price: 100 },
  eventId: "test_event_id"
});

//The event property status is 5 after reporting, with the price remaining the same
ta.trackUpdate({
  eventName: "UPDATABLE_EVENT",
  properties: { status: 5 },
  eventId: "test_event_id"
});

2.4 書き替えイベント

書き替えイベントは更新可能イベントと同じようで、書き替えイベントは過去データを最新のデータで上書きされるため、前のデータを削除し新しくデータを格納するように見られます。TEシステムはイベント名とイベントIDを識別対象として更新データを確定します。

// The event property status is 3 after reporting, with the price being 100
ta.trackOverwrite({
  eventName: "OVERWRITE_EVENT",
  properties: { status: 3, price: 100 },
  eventId: "test_event_id"
});

// The event property status is 5 after reporting, with the price deleted
ta.trackOverwrite({
  eventName: "OVERWRITE_EVENT",
  properties: { status: 5 },
  eventId: "test_event_id"
});

2.5 共通イベントプロパティ

共通イベントプロパティは全てのイベント送信する際に付属されているプロパティとなります。プロパティの更新頻度により、共通イベントプロパティは静的共通イベントプロパティと動的共通イベントプロパティがあります。実際業務ニーズに応じて、共通イベントプロパティの設定を行なってください；通常イベント送信する前に、共通イベントプロパティを設定しておいてください。同じイベントに、共通イベントプロパティ、イベントカスタムプロパティ、プリセットプロパティのKeyは同じの場合は、以下の優先順位で値付けされます。

カスタムプロパティ＞動的共通イベントプロパティ＞静的共通イベントプロパティ＞プリセットプロパティ

2.5.1 静的共通プロパティ

重要のプロパティに対しては：ユーザーのチャンネル、ニックネーム、IDなどはすべてのイベントの中に付属したい場合は、 setSuperPropertiesを利用して、静的共通イベントプロパティを設定してください。静的共通イベントプロパティはグローバルで有効となり、キャッシュはlocalStorageもしくはcookieに保存されます。（デフォルトでキャッシュが有効になっています）

静的共通プロパティのパラメータはJSON となり、イベントプロパティと一致する必要があります。

ta.setSuperProperties({ vip_level: 2});

プロパティ設定以外では、その他API利用で静的共通イベントプロパティの設定が可能です。

// obtain all certain super properties
var superProperties = ta.getSuperProperties();
// clear a certain super property
ta.unsetSuperProperty("channel");
// clear all certain super properties
ta.clearSuperProperties();

2.5.2 動的共通イベントプロパティ

動的共通イベントプロパティは高頻度変化かつ全てのイベントに属しているプロパティです。（例えばコインの数量）setDynamicSuperPropertiesTrackerを利用し動的共通イベントプロパティを設定した後で、SDKはイベント収集時に自動でgetDynamicSuperPropertiesのプロパティを取得し、イベント送信されます。

ta.setDynamicSuperProperties(function() {
  var d = new Date();
  d.setHours(10);
  return { date: d };
});

2.6 イベント時間記録

イベントの経過時間を記録したい場合は、timeEventを呼び出して計算可能です。計算したいイベント名称を設定し、該当イベントが送信される際に、自動的にイベントプロパティに#durationのプロパティを追加され、経過時間を記録されます。単位は秒です。

注意：一つイベントに対しては一個の時間経過計算タスクのみつけることが可能です。

//The following instance has recorded the time the user spent on a certain product page
ta.timeEvent("stay_shop");
/**do someting
    .......
**/
//the timing would end when the user leaves the product page. "stay_shop" event would carry#duration, a property representing event duration. 
ta.track("stay_shop",{product_name:"television"});

ユーザープロパティ

TEでユーザープロパティを設定するAPIは userSet、userSetOnce、userAdd、userUnset、userDel、userAppend、userUniqAppend。

3.1 userSet

一般的にユーザープロパティ設定はuserSetを用いて設定できます。この呼び出しを利用して元のプロパティ値を書き替えされます。元のプロパティ値がない場合は、新規作成になります。データタイプは格納されたデータタイプと一致します。以下は例：

//the username now is TA
ta.userSet({ username: "TA" });
//the username now is TE
ta.userSet({ username: "TE" });

3.2 userSetOnce

もしユーザープロパティは一回設定の上で変更がない場合は、userSetOnceを用いて設定できます。この呼び出しは値のある際に書き替えを行いません。

例：初回課金時間設定

//first_payment_time is 2018-01-01 01:23:45.678
ta.userSetOnce({first_payment_time: "2018-01-01 01:23:45.678" });
//first_payment_time is still 2018-01-01 01:23:45.678
ta.userSetOnce({first_payment_time: "2018-12-31 01:23:45.678" });

3.3 userAdd

もし数値型のプロパティで累積計算を行いたい場合は、userAddを用いて設定できます。この呼び出しは値のない際に自動で0を付与した上で計算されます。"-"値で計算することも可能で、例：累積課金金額

//in this case, the total_revenue is 30
ta.userAdd({ total_revenue: 30 });
//in this case, the total_revenue is 678
ta.userAdd({ total_revenue: 648 });

3.4 userUnset

ユーザープロパティをリセットしたい場合は、userUnsetを用いて設定できます。この呼び出しは文字列またはリスト型のパラメータをサポートしています。

//reset a single user property
ta.userUnset("userPropertykey");

3.5 userDel

ユーザーを削除したい場合はuserDelを用いて設定できます。削除したら当ユーザーのユーザープロパティはクエリできなくなりますが、当ユーザーが生成したイベントデータはクエリできます。

ta.userDel();

3.6 userAppend

userAppendを用いて、List型のユーザープロパティを追加できます。

ta.userAppend({ user_list: ["apple", "ball"] });

3.7 userUniqAppend

userUniqAppendを利用して、Array (List)型のユーザーデータにユニークエレメントを追加できます。userUniqAppendインターフェースは追加されたユーザープロパティを重複排除され、userAppendは重複排除しませんので、ユーザープロパティは重複される可能性があります。

//in this case, the property value of user_list is ["apple"，"ball"]
ta.userAppend({ user_list: ["apple", "ball"] });
//in this case, the property value of user_list is ["apple","apple","ball","cube"]
ta.userAppend({ user_list: ["apple", "cube"] });
//in this case, the property value of user_list is ["apple"，"ball","cube"]
ta.userUniqAppend({ user_list: ["apple", "cube"] });

送信データの暗号化対応

SDKは暗号化機能に対応しており、クライアントはAES + RSAでデータを暗号化処理してから、サーバ側で暗号化を解けます。クライアントとサーバ両方の作業があり、詳しくはTDスタッフまでお問い合わせください。

enableEncrypt プロパティはtrue、デフォルトのバージョンとパブリックキーを設定します。

var config = {
  appId: "YOUR_APP_ID", 
  serverUrl: "YOUR_SERVER_URL",
  enableEncrypt: true, // Enable the encryption function
  secretKey: {
    publicKey:'YOUR_PUBLIC_KEY', 
    version:0 
   }
};
var ta = new ThinkingAnalyticsAPI(config);
ta.init();

その他機能

5.1 デバイスIDを取得

getDeviceId()を利用して、デバイスIDの取得ができます。

var deviceId = ta.getDeviceId();

デバイスIDはキャッシュに保存し、ユーザーがキャッシュをクリアすると、IDはリセットされます。

5.2 onCompelete コールバック関数

::: Tips

AndroidとiOSプラットフォームには無効です。

:::

track, userSet, userSetOnce, userAdd, userDelなどの呼び出しはonCompleteのコールバック関数に対応しています。元のパラメーター リストの直後に onComplete を送信することも、パラメーター オブジェクトを使用することもできます。パラメータ オブジェクトを使用する場合は、パラメータ オブジェクトに onComplete を含める必要があります。そうしないと、パラメータ エラーが発生します。例：

// pass the callback as a list of arguments
ta.track("test", { testkey: 123 }, new Date(), res => {
  console.log(res);
});
// the callback is passed as a parameter object
ta.track({
  eventName: "test", 
  properties: { testkey: 123 }, 
  time: new Date(), 
  onComplete: res => {
    console.log(res);
  } 
});

onComplete のパラメータresはobejctタイプで、プロパティにはcode と msgがあります。

res.code は int タイプで、説明:

• 0: 成功
• -1: データタイプ不正
• -2: APP ID 無効
• -3: ネットまたはサーバ異常あり

Debug モードでの説明:

• 0: 成功
• -1: パラメータまたは権限チェックに問題あり
• 1: フィールドの基本的なエラーを示し、詳細なエラー フィールドと理由が示される
• 2: 全体エラーあり
• -3: ネットまたはサーバ異常あり

res.msg は res.code に対する文字説明です

5.3 イベントのキャッシュ送信設定

初期設定の時に、イベントキャッシュ送信を設定することが可能です。

var config = {
  appId: "YOU-APP-ID",
  serverUrl: "https://youserverurl.com", 
  enableBatch: true, // whether to enable batch event cache reporting.
  batchConfig: {
    size: 5, // the number of event cache reports
    interval: 5000 // Event cache reporting interval (milliseconds)
  }
};
// create TA instance
var ta = new ThinkingAnalyticsAPI(config);
// init
//after the initializer is actively called, the data is actually reported.
ta.init();