更新记录

0.0.2（2021-02-08）

新增支持小程序平台：

• 百度小程序；
• 抖音小程序；

0.0.1（2021-02-07）

新增埋点分析功能，支持如下功能：

1. 自定义埋点事件采集；
2. 注册埋点事件公共属性；
3. 用户属性设置功能；

平台兼容性

引用方式

<script>
    import sensors from '神策 uni-app JS SDK 路径/index.js';
    sensors.setPara({
        server_url:"https://xxxxx",       //数据上报地址 必填 @Platform All
        show_log:true,                    //日志打印  @Platform All
        name:'sensors',                   //参考小程序文档 @Platform 小程序
        app_flush_interval:20000,         //设置两次数据发送的最小时间间隔 @Platform Android&iOS
        app_flush_bulkSize:70,            //设置本地缓存日志的最大条目数，最小 50 条 @Platform Android&iOS
        app_flush_network_policy:20,      //设置 flush 时网络发送策略，默认 3G、4G、WI-FI 环境下都会尝试 flush  @Platform Android&iOS
        app_session_interval_time:20000,  //Session 时长，若 App 在后台超过设定事件，则认为当前 Session 结束，发送 $AppEnd 事件，单位毫秒 @Platform Andorid
        app_data_collect:true             //是否开启数据采集 @Platform Android
    });
    //初始化方法 @Platform H5、小程序
    sensors.init();

</script>

接口列表

setPara

适用平台：APP、H5、小程序

属性:

代码示例:

    sensors.setPara({
        server_url:"https://xxxxx",       //数据上报地址 必填 @Platform All
        show_log:true,                    //日志打印  @Platform All
        name:'sensors',                   //参考小程序文档 @Platform 小程序
        app_flush_interval:20000,         //设置两次数据发送的最小时间间隔 @Platform Android&iOS
        app_flush_bulkSize:70,            //设置本地缓存日志的最大条目数，最小 50 条 @Platform Android&iOS
        app_flush_network_policy:20,      //设置 flush 时网络发送策略，默认 3G、4G、WI-FI 环境下都会尝试 flush  @Platform Android&iOS
        app_session_interval_time:20000,  //Session 时长，若 App 在后台超过设定事件，则认为当前 Session 结束，发送 $AppEnd 事件，单位毫秒 @Platform Andorid
        app_data_collect:true             //是否开启数据采集 @Platform Android
    });

track

方法说明：代码埋点方法，调用该接口采集自定义事件

适用平台：APP、H5、小程序

代码示例:

sensors.track("eventName",{key : "value"});

getAppFlushInterval

方法说明：获取两次数据发送的最小时间间隔，单位毫秒

适用平台：Android、iOS

返回类型：number

getAppFlushBulkSize

方法说明：获取本地缓存日志的最大条目数

适用平台：Android、iOS

返回类型：number

getAppSessionIntervalTime

方法说明：获取 Session 时长

适用平台：Android

返回类型：number

getDistinctID

方法说明：获取当前用户的 distinctId

适用平台：Andorid、iOS、H5、小程序

返回类型：string

identify

方法说明：设置自定义匿名 ID

适用平台：Andorid、iOS、H5、小程序

getAnonymousID

方法说明：获取当前用户的匿名 ID

适用平台：Andorid、iOS、H5、小程序

返回类型：string

login

方法说明：登录，设置当前用户的登录 ID，触发用户关联事件

适用平台：Andorid、iOS、H5、小程序

logout

方法说明：注销，清空当前用户的登录 ID

适用平台：Andorid、iOS、H5、小程序

trackAppInstall

方法说明：记录 $AppInstall 事件，用于在 App 首次启动时追踪渠道来源，并设置追踪渠道事件的属性

适用平台：Andorid、iOS

appFlush

方法说明：将所有本地缓存的日志发送到 SA

适用平台：Andorid、iOS

register

方法说明：注册所有事件都有的公共属性

适用平台：Andorid、iOS、H5、小程序

代码示例:

sensors.register({key1:"value1",key2 : "value2",});

unRegister

方法说明：删除某些事件公共属性

适用平台：Andorid、iOS

代码示例:

sensors.unRegister("key1");     

clearRegister

方法说明：删除所有事件公共属性

适用平台：Andorid、iOS

setProfile

方法说明：设置用户属性

适用平台：Andorid、iOS、H5、小程序

代码示例:

sensors.setProfile({key1:"value1",key2:"value2"});

setOnceProfile

方法说明：首次设置用户属性，如果之前存在，则忽略，否则，新创建

适用平台：Andorid、iOS、H5、小程序

代码示例:

sensors.setOnceProfile({key1:"value1",key2:"value2"});

incrementProfile

方法说明：给一个或多个数值类型的 Profile 增加一个数值。只能对数值型属性进行操作，若该属性未设置，则添加属性并设置默认值为 0

适用平台：Andorid、iOS、H5、小程序

代码示例:

sensors.incrementProfile({key1:2,key2:2});

appendProfile

方法说明：给一个列表类型的用户属性增加一个元素

适用平台：Andorid、iOS、H5、小程序

代码示例:

appendProfile({fruit:["苹果","西瓜"]})

appendProfile({fruit:"西瓜"})

appendProfile({fruit1:["苹果","西瓜"],fruit2:["葡萄]})

unsetProfile

方法说明：删除用户的一个用户属性

适用平台：Andorid、iOS、H5

deleteProfile

方法说明：删除用户所有用户属性

适用平台：Andorid、iOS、H5

注意：以上方法，可以直接调用，不支持的端调用后无效，控制台会打印日志。