sa-sdk-mini-game 仓库的 layaair-game.min.js 暂停服务。
平台支持
| 平台 |
微信小游戏 |
QQ 小游戏 |
字节小游戏 |
H5 |
iOS |
Android |
| 支持 |
|
|
|
|
|
|
集成神策分析 SDK
从 GitHub 上 dist 目录获取 LayaAir SDK 源码
TypeScript
如果您的项目是 TypeScript 工程，接入步骤如下：
- 修改 tsconfig.json 文件，增加 "allowJs": true，允许编译 js 文件。
"compilerOptions": {
"module": "es6",
"target": "es6",
"baseUrl": "../libs",
"outDir": "../build/src",
"allowJs": true, //指定允许编译JS文件
}
- Laya 3.0 把 SDK 文件放入 assets 目录，在源码中引用。
- Laya 2.0 把 SDK 文件放入 src 目录下，在源码中引用。
//3.0 引入方式
import sensorsData from "../assets/js/sensors-laya.min.esm.js";
//2.0 引入方式
import sensorsData from "./sensors-laya.min.esm.js";
JavaScript
如果您的项目是 JavaScript 工程，接入步骤如下：
- 直接将 sensors-laya.min.esm.js 放入您的工程中，在源码中引用：
import sensorsData from "./sensors-laya.min.esm.js";
初始化
引入 SDK 后，在代码中使用 sensorsData 调用 init() 方法来初始化 SDK：
// 配置对象
var config = {
server_url: '数据上报 URL', // 数据上报 URL，必需
show_log: true,
super_properties: { superKey: 'value' },
mini: {
app_show: false, // 默认 false, 小游戏从后台进入前台。
app_hide: false // 默认 false, 小游戏从前台进入后台。
},
app: {
app_start: true, // 默认 false 启动
app_end: true // 默认 false 关闭
}
}
// 初始化
sensorsData.init(config);
// 上报一个事件，事件名为 test
sensorsData.track(
'test', // 事件名称
{ demo: 1 } // 事件属性
);
参数说明如下：
| 参数 |
类型 |
是否必填 |
默认值 |
含义 |
备注 |
| server_url |
String |
是 |
数据接收地址 |
数据接收地址 |
|
| super_properties |
Object |
否 |
无 |
设置公共静态属性 |
|
| show_log |
Boolean |
否 |
false |
是否打印 log |
- 设置 true 后会在模拟器控制台打 log，会显示发送的数据，设置 false 表示不显示。建议开启。
|
| mini |
Object |
否 |
无 |
是否开启自动采集 |
- 表示是否开启小游戏自动采集功能，默认全部关闭。
- 2 个属性参数（app_show、app_hide）。分别采集 $MPShow、$MPHide 事件。
注意：H5 平台不支持全埋点。
|
| app |
Object |
否 |
无 |
是否开启自动采集 |
- 表示是否开启 Native 自动采集功能，默认全部关闭。
- 2 个属性参数（app_start、app_end）。分别采集 $AppStart、$AppEnd 事件。
|
发布为微信 / QQ / 字节跳动等小游戏时，需要在相应的开发者平台配置数据接收地址的域名。
SDK 基本配置
配置项目数据接收地址
获取项目数据接收地址：
调试查看事件信息
事件的触发日志
配置初始化参数时，通过 show_log: true 打开 Log 功能且 SDK 完成初始化后（即 init() 方法调用后），开发者工具 console 会打印采集的数据信息
事件的发送情况
事件数据发送成功时，可以在开发者工具的 Network 模块中，可以看到 sa 的请求：
