白鹭引擎小游戏 SDK 使用指南

本文将会为您介绍如何使用 白鹭引擎 SDK 接入您的项目。建议在接入开始前，先阅读数据规则一章，在了解TA数据规则后再进行接入。您可以在访问 GitHub 获取白鹭引擎小游戏 SDK 的源代码。

最新版本为: 1.7.0

更新时间为: 2020-08-24

下载地址

1 集成 SDK

1.1 集成方法

1.下载并解压 Egret SDK.

2.引入 SDK 库与引入其他第三方库过程相同，在 egretProperties.json 中引入该库并编译引擎。需要注意库的位置应放在项目外。

{
     "name": "ThinkingAnalyticsSDK", 
     "path": "../libsrc/ThinkingAnalyticsSDK" 
}

引入到项目中之后编译引擎即可使用 SDK 库。

3.初始化 SDK

private ta: ThinkingDataAPI;

private initThinkingSDK(): void {
    var config = {
        appid: 'YOUR_APPID',
        server_url: 'YOUR_SERVER_URL',
        autoTrack: {
            appShow: true,
            appHide: true,
        }
    };

    this.ta = new ThinkingDataAPI(config);
    this.ta.init();
}

• appid是您的项目的 APP_ID，需要进行配置，在您申请项目时会给出，请在此处填入
• server_url为上传数据的 URL，需要进行配置
• autoTrack表示是否开启自动采集功能，每一个元素分别代表如下的自动采集事件，默认全部关闭：
• appShow自动采集小游戏启动，或从后台进入前台
• appHide自动采集小游戏从前台进入后台，并记录本次访问（启动至调入后台）的时间

关于自动采集事件的详细信息，可以查看自动采集事件一节

如果您使用的是云服务，请使用以下传输 URL:

https://receiver.ta.thinkingdata.cn

如果您使用的是私有化部署的版本，由于微信等平台的服务器域名中不能出现端口号，因此需要您自行配制域名，绑定 TA 私有化服务器的接收端。

在 config 中其他可选参数有：

var config = {
    //...
    enableLog: true, // 是否打开日志打印
    sendTimeout: 3000, // 网络请求超时时间，单位毫秒，默认值 3000 ms
    maxRetries: 3, // 网络请求失败时的重试次数，1 表示不重试。默认值是 3
    enablePersistence: true, // 是否使用本地缓存（用户ID、设备ID、公共属性记录在本地缓存），主实例默认为 true，子实例默认为 false
    //...
};

1.2 使用 SDK 实例

在其他页面中，可以调用以下代码获取 SDK 实例：

// 调用 SDK 方法
ta.track('test');

1.3 初始化 SDK 实例

在 SDK 集成完毕之后，即可调用 SDK 方法，但只有调用了 init 之后，数据才会被上报，在调用 init 之前触发的数据（包括自动采集数据），将会被暂存，直到 init 被调用时才会上报，这些数据的上报时间为埋点触发时间，而非 init 被调用的时间

init 被调用时，会将 init 调用前设置的用户 ID 以及公共属性同步到被暂存的数据中，动态公共属性会在 init 时获取上传值加入到事件中，也就是说在 init 调用前设置的用户 ID 以及公共属性会对所有数据生效，因此如果您需要设置用户 ID 或公共属性，请在调用对应接口之后再进行初始化。

ta.authorizeOpenID('authorizeOpenID');
ta.login("ABC_123456");
ta.setSuperProperties({"channel": "渠道"});

// 先设置 ID 以及公共属性再初始化
ta.init();

2. 设置用户 ID

在集成 SDK 之后，SDK 会使用 UUID 作为每个用户的默认访客 ID，该 ID 将会作为用户在未登录状态下身份识别 ID。需要注意的是，UUID 在用户更换设备及清理缓存时将会变更。

2.1 设置访客 ID

如果您希望使用其他ID来作为用户的访客ID，您可以调用 identify 或者 authorizeOpenID 来设置访客 ID（两个方法是等价的，根据使用习惯保留两个接口名）：

// 传入值为 openid
ta.authorizeOpenID('OpenID');
// identify 等价于 authorizeOpenID
ta.identify('OpenID');

需要注意以下几点：

1. 设置后的 OpenID 将会被设置为访客 ID #distinct_id，如果使用 login 传入账号 ID，则根据用户识别规则，会优先以账号 ID 为准
2. 如果需要进行设置，必须在 init 之前调用本接口

2.2 设置账号 ID

在用户产生登录行为时，可调用 login 来设置用户的账号 ID。TA 平台优先以账号 ID 作为身份标识，设置后的账号 ID 将会被保存，多次调用 login 将会覆盖先前的账号 ID：

// 用户的登录唯一标识，此数据对应上报数据里的 "#account_id"，此时 "#account_id" 的值为 "ABC_123456"
ta.login("ABC_123456");

// 再次调用 login 调整账号 ID，此时"#account_id" 的值为 "XYZ_987654"
ta.login("XYZ_987654");

请注意，该方法不会上传用户登录的事件

2.3 清除账号 ID

在用户产生登出行为之后，可调用 logout 来清除账号 ID，在下次调用 login 之前，将会以访客 ID 作为身份识别 ID：

// 去除上报数据里的 "#account_id"，之后的数据将不带有 "#account_id"
ta.logout();

请注意，该方法不会上传用户登出的事件

3. 发送事件

您可以直接调用 track 上传自定义事件，建议您根据先前梳理的文档来设置事件的属性以及发送信息的条件，此处以购买商品为范例：

ta.track(
   'Purchase',              // 追踪事件的名称
    {
        Item:'商品A',
        ItemNum:1,
        Cost:100,
        Elements: ['apple','ball','cat'],
    }                       // 需要上传的事件属性
);

• track 接口共有两个参数，第一个参数为事件的名称，第二个参数为事件的属性
• 事件的名称是字符串，只能以字母开头，可包含数字，字母和下划线“_”，长度最大为 50 个字符，对字母大小写不敏感。
• 事件的属性是 JS 对象，每个元素代表一个属性。
• 元素的 name 对应属性的名称，规定只能以字母开头，包含数字，字母和下划线“_”，长度最大为 50 个字符，对字母大小写不敏感。
• 元素的 value 为该属性的值，支持 String、Number、Boolean、Date 和 Array.

注意: Array 类型属性需要配合 TA 平台 2.5 及之后的版本.

3.1 设置事件上报时间

事件触发的时间默认取本机时间，但在一些情况下，可能需要手动设置事件的时间，可以使用以下方法进行调用：

// 第三个参数，可以输入 Date 类型的参数，替换事件触发时间
ta.track('event', {parakey: 'paravalue'}, new Date());

// 如果没有 properties 需要上传，请传入一个空对象
ta.track('event', {}, new Date());

• 第三个参数为事件触发时间，必须是Date类型，将会替换事件触发的时间，如果不传该参数，则事件触发时间默认选取用户的本机时间

3.2 记录事件时长

您可以调用 timeEvent 来开始计时，配置您想要计时的事件名称，当您上传该事件时，将会自动在您的事件属性中加入 #duration 这一属性来表示记录的时长，单位为秒。

// 用户进入商品页面，开始计时，记录的事件为 "Enter_Shop"
ta.timeEvent("Enter_Shop");

//...

// 上传事件，计时结束，"Enter_Shop" 这一事件中将会带有表示事件时长的属性 "#duration"
ta.track("Enter_Shop",{product_id: "A1354"});

3.3 设置公共属性

对于一些重要的属性，譬如用户的设备 ID、来源渠道、用户状态等，这些属性需要设置在每个事件中，此时您可以将这些属性设置为公共属性，即每个事件中都带有的属性。我们推荐您在发送事件前，先设置公共属性。

公共属性包含两种，事件公共属性和动态公共属性。在事件上报时，公共属性将会被插入到数据的 properties 中。如果此时公共属性与事件中设置的自定义属性有相同 key 值，则属性会根据下述优先级判断该取什么值：

用户自定义事件属性 > 动态公共属性 > 事件公共属性

3.3.1 设置事件公共属性

事件公共属性指的是静态的公共属性，在设置时只能传入常量，适合设置稳定不变的属性，您可以调用 setSuperProperties 来设置公共事件属性，公共事件属性的格式要求与事件属性一致。

根据属性优先级，自定义属性优先级高于事件公共属性，因此事件公共属性也可以作为某个属性的缺省值，在需要修改的事件中设置同名 Key 覆盖缺省值。

// 设置公共事件属性
ta.setSuperProperties({ channel: '渠道'});

// 使用track上传事件，此时事件中会带有公共事件属性
ta.track(
   'Purchase',              // 追踪事件的名称
    {
        Item:'商品A',
        ItemNum:1,
        Cost:100
    }                       // 需要上传的事件属性
);

/* 等价于在事件中加入这些公共属性
ta.track(
    'Purchase', // 追踪事件的名称
    {
        Item:'商品A',
        ItemNum:1,
        Cost:100,
        channel:'渠道' // 相当于在事件中加入这个属性
    } 
);
*/

如果多次调用 setSuperProperties 设置公共事件属性，则同名字段后面的调用会覆盖之前的，不同名字段。

如果您需要清除公共事件属性，可以调用 clearSuperProperties 将所有公共属性清除。

ta.clearSuperProperties();

3.3.2 设置动态公共属性

动态公共属性会在事件上报时，执行一个 function ，并把返回值作为该动态公共属性的值，加入到事件中。您可以调用 setDynamicSuperProperties 接口设置动态公共属性。该接口接受一个 function 作为参数。

// 通过动态公共属性设置 UTC 时间作为事件属性上报
ta.setDynamicSuperProperties(() => {
    var localDate = new Date();
    return {
        utcTime: new Date(localDate.getTime() + (localDate.getTimezoneOffset() * 60000)),
    };
});

function 必须返回一个 JS 对象，其中每个元素代表一个属性。 属性格式要求与事件属性一致。

4. 用户属性

4.1 设置用户属性（userSet）

对于一般的用户属性，您可以调用 userSet 来进行设置，使用该接口上传的属性将会覆盖原有的属性值，如果之前不存在该用户属性，则会新建该用户属性

// 设置用户属性，会员等级
ta.userSet({vip_level:'钻石会员'});

与上传事件时的事件属性一致，此处传入的用户属性也是对象类型，name 对应属性的名称，规定只能以字母开头，包含数字，字母和下划线“_”，长度最大为 50 个字符，对字母大小写不敏感，value 为该属性的值，支持 String、Number、Boolean、Date 和 Array。

注意：Array 类型需要配合 TA 平台 2.5 及之后版本使用.

4.2 初始化用户属性（userSetOnce）

如果您要上传的用户属性只要设置一次，则可以调用 userSetOnce 来进行设置，当该属性之前已经有值的时候，将会忽略这条信息。

// 以设置用户名为例，如果用户名已设置，则忽略本次设置，如果不存在，则设置为传入值
ta.userSetOnce({user_name:'TA'});

userSetOnce 的参数要求与 userSet 一致。

4.3 累加用户属性（userAdd）

当您要上传数值型的属性时，您可以调用 userAdd 来对该属性进行累加操作，如果该属性还未被设置，则会赋值 0 后再进行计算

// 以付费为例，用户每次付费时调用此接口，则 'total_revenue' 字段每次会做累加付费金额的处理
ta.userAdd({total_revenue:50});

与上传事件时的事件属性一致，此处传入的用户属性也是对象类型，name 对应属性的名称，规定只能以字母开头，包含数字，字母和下划线“_”，长度最大为 50 个字符，对字母大小写不敏感，value 为该属性需要累加的值，只支持 Number 类型，传入负数相当于做减法。

4.4 重置用户属性（userUnset）

当您要清空用户的某个用户属性值时，您可以调用 userUnset 来对指定属性进行清空操作，如果该属性还未在集群中被创建，则 userUnset 不会创建该属性

// 清空属性名为 userPropertykey 的用户属性值该用户，即设置成 NULL
ta.userUnset('userPropertykey');

4.5 删除用户（userDel）

如果您要删除某个用户，可以调用 userDel 将这名用户删除，您将无法再查询该名用户的用户属性，但该用户产生的事件仍然可以被查询到

ta.userDel();

4.6 为 Array 类型的用户属性追加元素 (userAppend)

您可以调用 userAppend 对 Array (List) 类型的用户数据追加元素。

ta.userAppend({'Elements':['a':1,'b':2]});

注意：该特性需要配合 TA 平台 2.5 及之后版本使用

5. 自动采集事件

在创建实例的 config 中开启您需要自动采集的事件，SDK 将会自动采集小游戏的一些行为，现在主要有以下几种事件支持自动采集：

现在支持的自动化收集数据有：

1. 小游戏回到前台的事件
2. 小游戏调入后台，并记录本次访问（启动至调入后台）的时间

接下来将会详细介绍每种数据的采集方法

5.1 开启自动采集事件

在 config 中，参数 autoTrack 中的元素表示每个自动采集事件的开关，设置为 true 为开启自动采集：

var config = {
    appid: 'YOUR_APPID',
    server_url: 'YOUR_SERVER_URL',
    autoTrack: {
      appShow: true, // 自动采集 ta_mp_show
      appHide: true, // 自动采集 ta_mp_hide
    }
};

• appShow：自动采集小游戏启动，或从后台进入前台
• appHide：自动采集小游戏从前台进入后台

5.2 自动采集事件详解

5.2.1 小游戏启动

小游戏启动将会在小游戏被启动、或小游戏被从后台调回前台时触发，详细的事件介绍如下：

• 事件名：ta_mp_show
• 自动采集属性：
• #scene，场景值，取自微信提供的场景值

小游戏启动由于会受到调出前后台的影响（条数较多），因此不太适合直接进行分析，但是可以在行为路径中标识用户的一次使用，可以作为用户行为路径的初始行为

5.2.2 小游戏隐藏

小游戏隐藏将会在小游戏被调入后台时触发，并记录本次使用的时长，详细的事件介绍如下：

• 事件名：ta_mp_hide
• 自动采集属性：
  • #scene，场景值，取自微信提供的场景值
  • #duration，数值型，表示本次启动（ta_mp_show）到隐藏的持续时长

小游戏隐藏事件会记录使用时长（单位为秒），因此可以直接计算用户使用总时长以及人均时长，也可以除以初始化次数计算单次使用时长。

6. 其他功能

6.1 多实例

本 SDK 支持多实例。我们称通过上文描述的方法完成初始化的实例 ta 为主实例，通过本节描述的方法创建的实例为子实例。

多个实例之间共享设备相关的预置属性（包括设备ID），其他的属性均不共享，包括：

• #distinct_id 访客 ID
• #account_id 账号 ID
• 公共事件属性、动态公共属性
• timeEvent 监控的事件

您可以通过创建子实例，向另一个项目中上报数据，或者以另一套用户 ID 上报数据。

// 创建子实例 tt， 子实例默认配置与主实例相同
ta.initInstance('tt');

ta.lightInstance('tt').identify('another_distinct_id');
ta.lightInstance('tt').track('event_from_tt_instance');

// 创建不同配置的子实例
var config = {
    appid: 'ANOTHER-APP-ID',
    enablePersistence: true, // 为子实例开启本地缓存
};

ta.initInstance('tt_1', config);
ta.lightInstance('tt_1').track('event_from_tt1_instance');

6.2 获取设备 ID

您可以调用 getDeviceId() 获取设备 ID，由于运行环境的原因，设备 ID 会保存在本地缓存，一旦用户删除缓存，则设备 ID 将会变更，因此设备 ID 不能保证稳定不变

var deviceId = ta.getDeviceId();

6.3 onCompelete 回调函数

对于 track, userSet, userSetOnce, userAdd, userDel 等接口，支持传入 onComplete 回调. 可以直接在原参数列表后传入 onComplete, 也可以使用参数对象的方式. 如果使用参数对象，参数对象中必须包含 onComplete, 否则会出现参数错误.

以上传事件为例：

// 以参数列表的形式传入回调
ta.track('test', {testkey:123}, new Date(), (res) => {
    console.log(res);
});

// 以参数对象的形式传入回调
ta.track({
    eventName: 'test', // 必填
    properties: {testkey: 123}, // 可选
    time: new Date(), // 可选
    onComplete: (res) => { console.log(res); }, // 必填
});

onComplete 的参数 res 为 object 类型，有两个属性 code 和 msg.

res.code 为 int 类型，定义如下:

• 0: 成功
• -1: 数据格式不正确
• -2: APP ID 无效
• -3: 网络或服务端异常

Debug 模式定义如下:

• 0: 成功
• -1: 参数或者权限校验的问题
• 1: 表示字段基本的错误, 会给出详细的错误字段和原由
• 2: 表示整条错误
• -3: 网络或服务端异常

res.msg 是对 res.code 的文字说明。

6.4 开启 Debug 模式

从 v1.6.0 版本开始，客户端 SDK 支持 Debug 模式，需要配合 TA 平台 2.5 之后的版本使用。

当前 SDK 实例支持三种运行模式：

• "none": 不开启Debug
• "debug": 开启Debug模式，并入库
• "debugOnly": 开启Debug模式，不入库

SDK 初始化：

var config = {
    appid: 'YOUR_APPID',
    server_url: 'YOUR_SERVER_URL',
    debugMode: 'debug'
};

ta = new ThinkingDataAPI(config);
ta.init();

为了避免 Debug 模式在生产环境上线，规定只有指定的设备才能开启 Debug 模式。只有在客户端开启了 Debug 模式，并且设备 ID 在 TA 后台的"埋点管理"页的"Debug数据"板块中配置了的设备才能开启 Debug 模式。

设备 ID 可以通过以下三种方式获取：

• TA 平台中事件数据中的 #device_id 属性
• 通过实例接口调用：获取设备 ID

7. 相关预置属性

7.1 所有事件带有的预置属性

以下预置属性，是小游戏 SDK 中所有事件（包括自动采集事件）都会带有的预置属性

7.2 自动采集事件的预置属性

以下预置属性，是各个自动采集事件中所特有的预置属性

• 小游戏隐藏（ta_mp_hide）的预置属性

8. 进阶功能

从 v1.7.0 开始，SDK 支持上报三种特殊类型事件: 首次事件、可更新事件、可重写事件。这三种事件需要配合 TA 系统 2.8 及之后的版本使用。由于特殊事件只在某些特定场景下适用，所以请在数数科技的客户成功和分析师的帮助下使用特殊事件上报数据。

8.1 首次事件

首次事件是指针对某个设备或者其他维度的 ID，只会记录一次的事件。例如在一些场景下，您可能希望记录在某个设备上第一次发生的事件，则可以用首次事件来上报数据。

// 示例：上报设备首次事件, 假设事件名为 DEVICE_FIRST
ta.trackFirstEvent({
    eventName: 'DEVICE_FIRST',
    properties: { 'INT_PROPERTY': 0 }
});

如果您希望以设备以外的其他维度来判断是否首次，则可以为首次事件设置 FIRST_CHECK_ID. 例如您需要记录某个账号的首次事件，可以将账号 ID 设置为首次事件的 FIRST_CHECK_ID:

// 示例：上报用户账号的首次事件, 假设事件名为 USER_FIRST
// 将用户 ID 设置为首次事件的 FIRST_CHECK_ID
ta.trackFirstEvent({
    eventName: 'USER_FIRST',
    firstCheckId: 'YOUR_ACCOUNT_ID',
    properties: { 'INT_PROPERTY': 0 }
});

注意：由于在服务端完成对是否首次的校验，首次事件默认会延时 1 小时入库。

8.2 可更新事件

您可以通过可更新事件实现特定场景下需要修改事件数据的需求。可更新事件需要指定标识该事件的 ID，并在创建可更新事件对象时传入。TA 后台将根据事件名和事件 ID 来确定需要更新的数据。

// 示例： 上报可被更新的事件，假设事件名为 UPDATABLE_EVENT
ta.trackUpdate({
    eventName: 'UPDATABLE_EVENT',
    properties: { 'status': 3 ,
                  'price': 100},
    eventId: 'test_event_id',
});
// 上报后事件属性 status 为 3, price 为 100

ta.trackUpdate({
    eventName: 'UPDATABLE_EVENT',
    properties: { 'status': 5 },
    eventId: 'test_event_id',
});
// 上报后事件属性 status 被更新为 5, price 不变

8.3 可重写事件

可重写事件与可更新事件类似，区别在于可重写事件会用最新的数据完全覆盖历史数据，从效果上看相当于删除前一条数据，并入库最新的数据。TA 后台将根据事件名和事件 ID 来确定需要更新的数据。

// 示例： 上报可被重写的事件，假设事件名为 OVERWRITE_EVENT
ta.trackOverwrite({
    eventName: 'OVERWRITE_EVENT',
    properties: { 'status': 3 ,
                  'price': 100},
    eventId: 'test_event_id',
});

// 上报后事件属性 status 为 3, price 为 100
ta.trackOverwrite({
    eventName: 'OVERWRITE_EVENT',
    properties: { 'status': 5 },
    eventId: 'test_event_id',
});

// 上报后事件属性 status 被更新为 5, price 属性被删除

Release Note

v1.7.0 2020/08/24

• 支持首次事件，可更新事件，可重写事件

v1.6.0 2020/06/10

• 支持 debug 模式

v1.5.1 2020/03/21

• 支持白鹭引擎小游戏平台：微信小游戏、百度小游戏、QQ小游戏、VIVO小游戏、OPPO小游戏
• 支持 LAYABOX 引擎小游戏平台：微信小游戏、百度小游戏、QQ小游戏、VIVO小游戏、OPPO小游戏
• 支持 CocosCreator 引擎小游戏平台：微信小游戏、百度小游戏、VIVO小游戏、OPPO小游戏