更新记录

0.1.7（2024-01-12）

1. 新增
   • 支持 resetAnonymousIdentity 和 getIdentities 接口

0.1.6（2023-12-23）

1. 修复
   • iOS 插件打包问题

0.1.5（2023-07-06）

1. 修复
   • iOS 端插件版本信息采集异常的缺陷

平台兼容性

原生插件通用使用流程：

1. 购买插件，选择该插件绑定的项目。
2. 在HBuilderX里找到项目，在manifest的app原生插件配置中勾选模块，如需要填写参数则参考插件作者的文档添加。
3. 根据插件作者的提供的文档开发代码，在代码中引用插件，调用插件功能。
4. 打包自定义基座，选择插件，得到自定义基座，然后运行时选择自定义基座，进行log输出测试。
5. 开发完毕后正式云打包

付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios

注意事项：使用HBuilderX2.7.14以下版本，如果同一插件且同一appid下购买并绑定了多个包名，提交云打包界面提示包名绑定不一致时，需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择

神策 uni-app-native SDK 使用文档

使用说明

适用范围

本插件适用于 Android & iOS进行数据采集。

引入方式

const sensors = uni.requireNativePlugin('Sensorsdata-UniPlugin-App');

2.2. API

initSDK

方法说明：初始化 SDK

代码示例:

    sensors.initSDK({
        server_url:'数据接收地址',
        show_log:false,//是否开启日志
        global_properties:{},//全局属性，object 类型
        app:{// Android & iOS 初始化配置
            remote_config_url:"",
            flush_interval:15000,//两次数据发送的最小时间间隔，单位毫秒
            flush_bulkSize:100,//设置本地缓存日志的最大条目数，最小 50 条， 默认 100 条
            flush_network_policy:30, //设置 flush 时网络发送策略
            auto_track:0,  // 1 应用启动， 2 应用退出，3 应用启动和退出 默认 0
            encrypt:false,  //是否开启加密
            track_crash:false, // 是否采集 AppCrash 事件
            add_channel_callback_event:false,//是否开启渠道事件
            javascript_bridge:false, // WebView 打通功能
            android:{//Android 特有配置
                session_interval_time:30000,
                request_network:true,
                max_cache_size:32,     // 默认 32MB，最小 16MB
                mp_process_flush:false,//使用小程序 SDK 时，小程序进程是否可发送数据
            },
            ios:{//iOS 特有配置
                max_cache_size: 10000, //最大缓存条数，默认 10000 条
            }
        }
    });

track

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

代码示例:

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

trackViewScreen

方法说明：触发页面浏览事件

代码示例:

 sensors.trackViewScreen("/new/detail",{key1:"value1",key2:"value2"}); 

trackTimerStart

方法说明：初始化事件的计时器，计时单位：秒 返回：交叉计时事件 Id

代码示例:

 sensors.trackTimerStart("detail");  

trackTimerPause

方法说明：暂停事件计时器

代码示例:

 sensors.trackTimerPause("detail");  

trackTimerResume

方法说明：恢复事件计时器

代码示例:

 sensors.trackTimerResume("detail");  

trackTimerEnd

方法说明：停止事件计时器，触发事件

代码示例:

 sensors.trackTimerEnd("detail");  

removeTimer

方法说明：移除特定事件计时器

代码示例:

 sensors.removeTimer("detail");  

clearTrackTimer

方法说明：清除所有事件计时器

代码示例:

 sensors.clearTrackTimer();  

setServerUrl

方法说明：设置数据上报地址

代码示例:

 sensors.serverUrl("数据接收地址"); 

enableLog

方法说明：设置是否开启 log

 sensors.enableLog(true)

getPresetProperties

方法说明：返回预置属性 返回类型：object

 var presetProperties = sensors.getPresetProperties(true)

setFlushInterval

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

 sensors.setFlushInterval(30000); 

getFlushInterval

方法说明：返回两次数据发送的最小时间间隔，单位毫秒 返回类型：number

 var interval = sensors.getFlushInterval(); 

setFlushBulkSize

方法说明：设置本地缓存日志的最大条目数，最小 50 条， 默认 100 条。

 sensors.setFlushBulkSize(200); 

getFlushBulkSize

方法说明：返回本地缓存日志的最大条目数。 返回类型：number

 var bulkSize = sensors.getFlushBulkSize(); 

setSessionIntervalTime

方法说明：设置 App 切换到后台与下次事件的时间间隔，默认值为 30*1000 毫秒， 若 App 在后台超过设定事件，则认为当前 Session 结束，发送 $AppEnd 事件

 sensors.setSessionIntervalTime(20000); 

getSessionIntervalTime

方法说明：获取 Session 时长。 返回类型：number

 var session = sensors.getSessionIntervalTime(); 

setFlushNetworkPolicy

方法说明：设置 flush 时网络发送策略，默认 3G、4G、WI-FI、5G 环境下都会尝试 flush

 sensors.setFlushNetworkPolicy(31); 

identify

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

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

 sensors.identify("匿名 ID"); 

getAnonymousID

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

返回类型：string

 var anonymosID = sensors.getAnonymousID(); 

getDistinctID

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

返回类型：string

 var distinctID = sensors.getDistinctID(); 

login

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

 sensors.login("loginID"); 

getLoginID

方法说明：获取当前用户的登录 ID

返回类型：string

 var loginID = sensors.getLoginID(); 

logout

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

 sensors.logout(); 

loginWithKey

方法说明：登录，设置当前用户的登录 IDKey 和 loginId

 sensors.loginWithKey("loginIDKey","loginID");

bind

方法说明：绑定业务 ID $identity_mobile、$identity_email 为神策定义业务 key，支持自定义 key

 sensors.bind("$identity_mobile","187****8991");

unbind

方法说明：解绑业务 ID

 sensors.unbind("$identity_mobile","187****8991");

getIdentities

方法说明：获取已绑定的业务 ID 列表

返回类型：object

 var identities = sensors.getIdentities();

resetAnonymousIdentity

方法说明： ID-Mapping 3.0 重置匿名 ID，只有在未登录情况下可以使用。

 sensors.resetAnonymousIdentity("identity"); 

trackAppInstall

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

 sensors.trackAppInstall(); 

flush

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

 sensors.flush(); 

registerSuperProperties

方法说明：注册事件公共属性

代码示例:

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

unregisterSuperProperty

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

代码示例:

 sensors.unregisterSuperProperty("key1"); 

clearSuperProperties

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

 sensors.clearSuperProperties(); 

getSuperProperties

方法说明：获取事件公共属性

 var superProperties = sensors.getSuperProperties(); 

profileSet

方法说明：设置用户属性

代码示例:

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

profileSetOnce

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

代码示例:

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

profileIncrement

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

代码示例:

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

profileAppend

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

代码示例:

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

profileUnset

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

 sensors.profileUnset('key1'); 

profilePushId

方法说明：设置用户推送 ID

 sensors.profilePushId("pushKey","pushId");      

profileUnsetPushId

方法说明：删除用户设置的推送 ID

 sensors.profileUnsetPushId('pushKey'); 

profileDelete

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

 sensors.profileDelete(); 

enableTrackScreenOrientation

方法说明：开启/关闭采集屏幕方向

 sensors.enableTrackScreenOrientation(true)

resumeTrackScreenOrientation

方法说明：恢复采集屏幕方向

 sensors.resumeTrackScreenOrientation(); 

stopTrackScreenOrientation

方法说明：停止采集屏幕方向

 sensors.stopTrackScreenOrientation(); 

getScreenOrientation

方法说明：获取屏幕方向 返回：portrait:竖屏，landscape:横屏

 var screenOrientation = sensors.getScreenOrientation(); 

trackDeepLinkLaunch

方法说明：Deeplink 唤起事件

 sensors.trackDeepLinkLaunch("scheme://host/path","oaid"); 

enableDeepLinkInstallSource

方法说明：DeepLink 是否采集设备信息

 sensors.enableDeepLinkInstallSource(true)

popupInit

方法说明：弹窗 SDK 初始化，需在 initSDK 之后调用

sensors.popupInit({
    // SFO 在线服务地址，由 SF 后端提供
    api_base_url: '',
    enable_popup:true,//初始化后是否允许弹窗，若禁止则在需要弹窗时调用 enablePopup  @platform Android
});

弹窗回调

方法说明：处理弹窗的各回调接口,需在弹窗 SDK 初始化后调用

代码示例

//弹窗展示成功回调
sensors.popupLoadSuccess( (json) => {
    console.log(json);
});
//弹窗点击回调
sensors.popupClick( (json) => {
    console.log(json);
});
//弹窗关闭回调
sensors.popupClose( (json) => {
    console.log(json);
});
// 弹窗加载失败回调
sensors.popupLoadFailed( (json) => {
    console.log(json);
});