- 在使用前，请先阅读数据模型
- SDK 更新日志，可参考 Release Notes
注意：
- 如果您已经是在 2016-5-15 日之前用的 0.6.1 版本的微信小游戏 SDK，请不要对微信小游戏 SDK 进行升级。如果有升级需求请咨询技术顾问。
集成神策分析 SDK
导入 SDK
- 从 GitHub 上获取
/dist/源码； - 将
/dist/game-xx/index.esm文件放入小游戏项目中； - 在 game.js 文件中通过 import 引入 SDK。
import sensors from 'sensorsdata.es6.min.js'下载下来的文件夹参考：
| /dist/下的文件目录 | 含义 |
|---|---|
| game-bytedance | 字节小游戏 |
| game-wechat | 微信小游戏 |
| game-qq | QQ 小游戏 |
| game-h5 | H5 小游戏 |
开启全埋点
如果需要自动采集，启动（小程序显示）、退出（小程序隐藏）这些事件，可以使用全埋点插件。
import sa from '/dist/game-xx/index.esm'
import autotrack from '/dist/game-xx/plugin/autotrack/index.esm'
sa.use(autotrack,{
app_show: true,
app_hide: true
});初始化 SDK
引入 SDK 后，可通过 init 可进行 SDK 初始化参数配置：
import sensors from '/dist/game-xx/index.esm'
import autotrack from '/dist/game-xx/plugin/autotrack/index.esm'
sensors.use(autotrack,{
app_show: true,
app_hide: true
});
sensors.init({
server_url: '数据接收地址'
});初始化可选参数
sensors.init 中可选的参数如下
| 配置名 | 默认值 | 含义 |
|---|---|---|
| server_url | 空字符串 | 数据接收地址 |
| show_log | false | 是否显示日志 |
batch_send.send_timeout | 6000 | 6000 毫秒发送一次数据 |
batch_send.max_length | 6 | 存储满 6 条后发送一次数据 |
max_string_length | 500 | 上报的字符串属性值最多 500 长度，多余的会被截取 |
SDK 基本配置
配置项目数据接收地址
神策分析 v2.2 以上可如下图所示获取数据接收地址，其他版本获取数据接收地址，可切换文档版本查看：
- 打包发布为微信/ QQ / 字节跳动 等小游戏时，需要在相应的开发者平台配置数据接收地址的域名，详情参考：https://developers.weixin.qq.com/miniprogram/dev/framework/ability/network.html
设置事件公共属性
对于所有事件都需要添加的属性，可在初始化 SDK 前，调用 registerApp() 将属性注册为公共属性：
sensors.registerApp({
userLever: 'VIP3',
userSex: '男'
});用户登录
当用户注册成功或者登录成功时，需要调用 login() 方法传入登录 ID：
sensors.login("登录 ID");对于自动登录的用户，可以在 SDK 初始化前，获取登录 ID 并调用 login() 方法。
代码埋点追踪事件
可通过 track() 方法追踪用户行为事件，并为事件添加自定义属性：
sensors.track('click',{
name: '点击'
});
调试查看事件信息
事件的触发日志
init() 配置初始化参数时，通过 show_log: true 打开 Log 功能，开发者工具 console 会打印采集的数据信息：
事件的发送情况
事件数据发送成功时，可以在开发者工具的 Network 模块中，可以看到 sa 的请求：
SDK 可选配置
设置用户属性
setProfile( properties ): 可以设定用户属性，同一个 key 多次设置时，value 值会进行覆盖替换：
sensors.setProfile({
email:'xxx@xx',
favoriteFruits: ['苹果', '油桃'],
subscribers: 7277
});