API功能
一、启动配置接口
BonreeSDK启动接口
启动小程序SDK需要调用start
函数,并在参数对象中设置Config地址与AppID。
function start({
configAddress: "",
appId: ""
})
- 接口说明
参数名 | 类型 | 注释 |
---|---|---|
configAddress | String | Config地址 |
appId | String | 博睿SDK平台生成的应用唯一ID |
示例
const BonreeSDK = require('./BonreeSDK_MP.min.js') const BRSAgent = BonreeSDK.start({ configAddress: "https://demtest.bonree.com/800config", appId: "db012cbf-a6d3-46a5-89ad-3e0edebbba06" })
设置小程序版本
小程序版本默认获取真实版本号。如有主动配置需求,需要启动接口参数中设置verson
字段即可。
- 接口说明
参数名 | 类型 | 注释 |
---|---|---|
version | String | 需要设置的版本信息 |
示例
const BRSAgent = BonreeSDK.start({ configAddress: "https://demtest.bonree.com/800config", appId: "db012cbf-a6d3-46a5-89ad-3e0edebbba06", version: "1.0.0" })
小程序默认的版本号在微信小程序开发者后台中发布时设置,debug环境下获取不到,建议根据真实版本情况设置,保证数据的完整性。
设置渠道
小程序SDK支持渠道信息设置,在启动接口参数中设置channelId
字段即可。
- 接口说明
参数名 | 类型 | 注释 |
---|---|---|
channelId | String | 需要设置的渠道名称 |
示例
const BRSAgent = BonreeSDK.start({ configAddress: "https://demtest.bonree.com/800config", appId: "db012cbf-a6d3-46a5-89ad-3e0edebbba06", channelId: "channel001" })
设置自定义的设备ID
设备ID(deviceID)默认由SDK生成并在local storage中保存。如有主动配置需求,在启动接口参数中设置deviceId
字段即可。
- 接口说明
参数名 | 类型 | 注释 |
---|---|---|
deviceId | String | 需要设置的设备ID |
示例
const BRSAgent = BonreeSDK.start({ configAddress: "https://demtest.bonree.com/800config", appId: "db012cbf-a6d3-46a5-89ad-3e0edebbba06", deviceId: "0123456789" })
二、自定义功能接口
一般自定义接口的调用位置不在小程序的入口文件App.js
中,因此需要在调用接口的文件开头引入SDK实例化对象:
const BRSAgent = require("../../app")
通常情况下在代码中直接键入实例化对象后,微信开发者工具会自动补全对象的引用。
自定义用户信息
BonreeSDK支持设置与用户相关的信息,从而完成性能数据与实际用户相关联的需求场景。
设置用户信息有两种方式:
1. 设置用户ID,以字符串形式给用户做标识。接口如下:
/// 设置用户ID
function setUserId(userId)
- 接口说明
参数名 | 类型 | 注释 |
---|---|---|
userId | String | 用户ID |
示例
BRSAgent.setUserId("1234")
2. 以对象形式设置用户附加信息。接口如下:
/// 设置附加信息
function setExtraInfo(extraInfo)
- 接口说明
参数名 | 类型 | 注释 |
---|---|---|
extraInfo | Object | 用户附加信息。 |
示例
BRSAgent.setExtraInfo({ key0: "value0", key1: "value1" })
自定义视图
调用接口并传入相应参数,可完成自定义视图数据统计功能。
/// 自定义视图——标记视图开始(和视图结束方法成对调用)
function customPageStart(name, alias)
/// 自定义视图——标记视图结束(和视图开始方法成对调用)
function customPageEnd(name, alias)
- 接口说明
参数名 | 类型 | 注释 |
---|---|---|
name | String | 视图名称。必传参数,空或空串接口调用无效。 |
alias | String | 视图别名。可选参数。 |
示例
BRSAgent.customPageStart("page01", "首页") BRSAgent.customPageEnd("page01", "首页")
注意:自定义视图的开始与结束记录接口必须成对调用,并且同一视图的name必须一致,才能正确统计一个完整自定义视图数据并上报。
自定义事件(完整版)
分别调用开始与结束接口并传入相应参数,可完成自定义事件数据与事件持续时间的统计功能。
/// 自定义事件开始
function customEventStart(eventId, eventName, eventParam, eventLabel)
/// 自定义事件结束
function customEventEnd(eventId, eventName, eventParam, eventLabel)
- 接口说明
参数名 | 类型 | 注释 |
---|---|---|
eventId | String | 事件ID。必传参数,空或空串接口调用无效。 |
eventName | String | 事件名称,可选参数。 |
eventParam | String | 附加信息(预留字段,暂无使用场景),可选参数。 |
eventLabel | String | 事件标签,可选参数。 |
示例
BRSAgent.customEventStart("001", "用户登录", "", "Login") // Some code... BRSAgent.customEventEnd("001", "用户登录", "", "Login")
注意:自定义时间开始与结束的匹配使用eventID唯一匹配,使用时请确保未结束事件ID的唯一性。
自定义事件(精简版)
调用接口并传入相应参数,可完成自定义事件数据统计功能。
/// 自定义事件
function customEvent(eventId, eventName, eventParam, eventLabel)
- 接口说明
参数名 | 类型 | 注释 |
---|---|---|
eventId | String | 事件ID。必传参数,空或空串接口调用无效。 |
eventName | String | 事件名称,可选参数。 |
eventParam | String | 附加信息(预留字段,暂无使用场景),可选参数。 |
eventLabel | String | 事件标签,可选参数。 |
示例
BRSAgent.customEvent("001", "用户登录", "", "Login")
自定义日志
调用接口并传入相应参数,可完成自定义日志数据统计功能。
/// 自定义日志
function customLog(info, param)
- 接口说明
参数名 | 类型 | 注释 |
---|---|---|
info | String | 日志信息。必传参数,空或空串接口调用无效。 |
param | String | 附加信息(预留字段,暂无使用场景),可选参数。 |
示例
BRSAgent.customLog("2020-01-01 08:30:00 Print log info.")
自定义指标
调用接口并传入相应参数,可完成自定义指标数据统计功能。
/// 自定义指标
function customMetric(metricName, metricValue, param)
- 接口说明
参数名 | 类型 | 注释 |
---|---|---|
metricName | String | 指标名称。必传参数,空或空串接口调用无效。 |
metricValue | Number | 指标值。必传参数,指标为空接口调用无效。 |
param | NSString | 附加信息(预留字段,暂无使用场景),可选参数。 |
示例
BRSAgent.customMetric("测试指标01", 1)