layabox 打印_Layabox 集成指南

LAYABOX 引擎小游戏 SDK 使用指南

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

最新版本为: 1.7.0

更新时间为: 2020-08-24

1 集成 SDK

1.1 集成方法

2.引入 SDK 库

import ThinkingDataAPI from "./thinkingdata.mg.laya.min";

3.初始化 SDK

var config = {

appid: 'YOUR_APPID',

server_url: 'YOUR_SERVER_URL',

autoTrack: {

appShow: true,

appHide: true,

}

};

var ta = new ThinkingDataAPI(config);

ta.init();

appid是您的项目的 APP_ID，需要进行配置，在您申请项目时会给出，请在此处填入

server_url为上传数据的 URL，需要进行配置

autoTrack表示是否开启自动采集功能，每一个元素分别代表如下的自动采集事件，默认全部关闭：

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

appHide自动采集小游戏从前台进入后台，并记录本次访问(启动至调入后台)的时间

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

在上报数据之前，请先在微信公众平台或其他平台的开发设置中，将数据传输 URL 加入到服务器域名的 request 列表中

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

如果您使用的是私有化部署的版本，由于微信等平台的服务器域名中不能出现端口号，因此需要您自行配制域名，绑定 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 或公共属性，请在调用对应接口之后再进行初始化。

为了以避免重复用户的情况发生，如果您调用 authorizeOpenID 设置访客 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');

需要注意以下几点：

设置后的 OpenID 将会被设置为访客 ID #distinct_id，如果使用 login 传入账号 ID，则根据用户识别规则，会优先以账号 ID 为准

如果需要进行设置，必须在 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.