1. 集成神策分析 SDK

1.1. 引入 SDK

  • 从 GitHub 上获取 Egret SDK 源码
  • 将  SDK ( egret-game.min.js ) 文件放入项目目录中
  • 使用编辑器打开小游戏项目，在 src 目录下 Main.ts 文件中通过 import 引入 SDK 文件
import sensors from './build/egret-game.min.js'
JS

1.1.1. 配置初始化参数

  • 引入 SDK 后，可通过 setPara()  配置 SDK 初始化参数：
sensors.setPara({
	server_url: '您的数据接收地址',
	// 是否允许控制台打印查看埋点数据(建议开启查看)
	show_log: true,
});
JS

1.1.2. 初始化可选参数

配置名

默认值

含义

server_url空字符串数据接收地址
show_logfalse是否显示日志

batch_send.send_timeout

60006000 毫秒发送一次数据

batch_send.max_length

6存储满 6 条后发送一次数据

max_string_length

500上报的字符串属性值最多 500 长度，多余的会被截取

1.1.3. 初始化 SDK

  • 调用 init() 方法来初始化 SDK：
// 引入 SDK
import sensors from './build/egret-game.min.js'
// 配置 SDK 参数
sensors.setPara({
	server_url: '您的数据接收地址',
	// 是否允许控制台打印查看埋点数据(建议开启查看)
	show_log: true,
});
class Main{
	constructor(){
		...
		// 初始化 SDK, 建议将 sensors.init() 调用放在 Main 的构造函数最底部执行，保证 Egret 初始化完成后再初始化神策 Egret SDK
		sensors.init();
	}
	
}
JS


  • 在调用 init() 接口之前，采集的数据被缓存在内存中；调用 init() 接口后，会将缓存的数据通过网络发送出去。

2. SDK 基本配置

2.1. 配置项目数据接收地址

获取项目数据接收地址：


2.2. 设置事件公共属性

对于所有事件都需要添加的属性，可在初始化 SDK 前，调用 registerApp() 将属性注册为公共属性：

sensors.registerApp({
	userLever: 'VIP3',
	userSex: '男'
});
JS

2.3. 用户登录

当用户注册成功或者登录成功时，需要调用 login() 方法传入登录 ID：

sensors.login("登录 ID");
JS

对于自动登录的用户，可以在 SDK 初始化前，获取登录 ID 并调用 login() 方法。

2.4. 代码埋点追踪事件

可通过 track() 方法追踪用户行为事件，并为事件添加自定义属性：

import sensors from './sensorsdata.min.js'
sensors.track('click',{
	name: '点击'
});
JS

3. 调试查看事件信息

3.1. 事件的触发日志

setPara() 配置初始化参数时，通过 show_log: true 打开 Log 功能且 SDK 完成初始化后（即 init() 方法调用后），开发者工具 console 会打印采集的数据信息：


3.2. 事件的发送情况

事件数据发送成功时，可以在开发者工具的 Network 模块中，可以看到 sa 的请求：

4. SDK 可选配置

4.1. 设置用户属性

setProfile( properties ): 可以设定用户属性，同一个 key 多次设置时，value 值会进行覆盖替换：

sensors.setProfile({
	email:'xxx@xx',
	favoriteFruits: ['苹果', '油桃'],
	subscribers: 7277
});
JS