• 在使用前,请先阅读数据模型
  • SDK 更新日志,可参考 Release Notes
  • 目前不支持使用 uni-app 框架开发的小程序

1. 集成神策分析 SDK

1.1. 导入 SDK

  • GitHub 上获取百度小程序 SDK 源码
  •  sensorsdata.autotrack.min.js 文件放入小程序项目中
  • app.js 文件中通过 require() 引入 SDK
var sa = require('./utils/sensorsdata.autotrack.min.js');
JAVASCRIPT
  • GitHub上获取百度小程序 SDK 源码
  • sensorsdata.autotrack.min.js 文件放入小程序项目中
  • app.jsx 中通过 import 引入 SDK
import sa from './util/sensorsdata.custom.min.js'
JAVASCRIPT
  • 百度小程序 SDK 压缩文件 sensorsdata.autotrack.min.js 大小约为 16 KB
  • 需要在 App 实例化之前调用 setPara() init(),否则可能会造成部分预置事件丢失

1.2. 配置初始化参数

引入 SDK 后,可通过 setPara() 可进行 SDK 初始化参数配置:

sa.setPara({
    name: 'sensors',
    server_url: '您的数据接收地址',
    // 全埋点控制开关
	autoTrack: {},
})
JS

1.3. 初始化 SDK

setPara() 配置初始化参数后,可调用 init() 方法来初始化 SDK:

// 初始化 SDK
sa.init();
JS

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

2. SDK 基本配置

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

神策分析 v2.2 以上可如下图所示获取数据接收地址,其他版本获取数据接收地址,可切换文档版本查看:

获取到数据接收地址之后在 setPara 接口中设置 server_url,server_url 的域名需要按照百度小程序要求(https://smartprogram.baidu.com/docs/third/info/set_server_domain/)配置小程序服务器域名。

2.2. 开启全埋点

setPara() 函数中 autoTrack 可用于配置需要开启的全埋点类型:

sa.setPara({
	autoTrack:{ 
		appLaunch:true, // 默认为 true,false 则关闭 $MPLaunch 事件采集,
		appShow:true, // 默认为 true,false 则关闭 $MPShow 事件采集
		appHide:true, // 默认为 true,false 则关闭 $MPHide 事件采集
		pageShow:true, // 默认为 true,false 则关闭 $MPViewScreen 事件采集
		mpClick: true // 默认为 true,false 则关闭 $MPClick 事件采集
	}

	/**
	 * 其他配置
	 */
});
JS

2.3. 设置事件公共属性

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

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

2.4. 用户登录

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

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

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

2.5. 代码埋点追踪事件

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

getApp().sensors.track('click',{
	name: '点击'
});

JS

3. 调试查看事件信息

3.1. 事件的触发日志

setPara() 配置初始化参数时,通过 show_log: true 打开 Log 功能(默认开启)且 SDK 初始化完成后,百度开发者工具 console 会打印采集的数据信息:

3.2. 事件的发送情况

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

4. SDK 可选配置

4.1. 设置用户属性

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

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

4.2. 渠道追踪

  • 用户通过含有 utm 相关参数的路径访问小程序时,预置事件 $MPLaunch、$MPShow 会解析启动路径中的 utm 相关参数作为自身的属性与属性值,并会设置 $latest_utm 相关属性到所有事件中,在程序的生命周期内有效;
  • 支持自定义渠道追踪。