更新记录

1.0.2(2023-04-03) 下载此版本

  1. 新增设置 ald_login_id 、ald_platform_type 公共属性
  2. 新增获取 distinct_id 的方法

1.0.1(2023-03-07) 下载此版本

支持在 uni-app 框架中,调用阿拉丁 Android & iOS SDK 的相关接口,完成事件采集


平台兼容性

Android Android CPU类型 iOS
适用版本区间:5.0 - 12.0 armeabi-v7a:未测试,arm64-v8a:未测试,x86:未测试 适用版本区间:9 - 15

原生插件通用使用流程:

  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 快速接入

详细文档可查看:uni-app-native SDK快速接入

1. 初始化阿拉丁SDK

const aldSdk = uni.requireNativePlugin('Ald-SdkUniPlugin');

2. initSDK

2.1 在阿拉丁统计平台申请appKey https://fenxi.aldwx.com/application/create

2.2 initSDK

  aldSdk.initSDK({
         appkey: '传入阿拉丁创建应用时生成的appKey',
          debug: true
  });
  • 注:集成SDK测试过程中,请将SDK初始化设置中的“debug”字段值设置为:true,否则将无法进行集成校验。每次埋点都请将debug字段值传为true,以免为正式项目产生脏数据。当埋点校验完成,进行正式上报时将debug字段值设为false
  • 正式上报时将debug字段值设为false,改完后需要将app删除,重新运行

3. 上报预定义事件

SDK 初始化后,可以通过 trackPredefined()方法埋点预定义事件,并为事件添加预定义属性, 注意预定义事件需以大写字母开头的Ald为前缀,预定义属性需以ald_为前缀,例如:

 // 预定义
 aldSdk.trackPredefined("AldRegisterResult", {
       ald_register_method: "账号密码",
       ald_account: "zhanyang123",
      ald_is_success: true,
       ald_fail_reason: ""
 })

4. 上报自定义事件

SDK 初始化后,可以通过 trackEvent()方法埋点自定义事件,并为事件添加自定义属性, 注意自定义事件需要避开预定义和保留关键字的命名规范,例如:

// 自定义
aldSdk.trackEvent("BuyProduct", {
      ProductID: "123456",
      ProductCatalog: "电脑"
 })
  • 注:自定义事件以及自定义属性的命名限制,请参考:数据采集规范

5. 渠道追踪

对于应用商店上传带有标记的渠道包( apk 包),便于区分每个渠道的下载量。可以使用 dloadChannel() 来记录下载商店的渠道,这里 dloadChannel() 只是一个示例,如果需要多个字段来标记渠道包,请按业务实际需要添加:

//以OPPO渠道为例
aldSdk.dloadChannel("oppo");

6. 记录激活事件

可以调用 trackAppInstall()方法记录激活事件,多次调用此方法只会在第一次调用时触发激活事件,Android 端需要在代码里开启获取 IMEI 权限( android.permission.READ_PHONE_STATE ),例:

aldSdk.trackAppInstall();

7. 触发页面浏览事件

手动触发页面浏览事件是由于SDK无法自动采集用户使用过程中的页面浏览事件,因此如果需要统计页面访问数据,需要手动触发该事件

aldSdk.trackViewScreen("pages/sample/ext-module.nvue");

8. 用户登录

当用户注册成功或登录成功时,可以额外在所有Event里面调用setLoginId("ald_login_id")方法,加入ald_login_id属性标识用户的正式ID,这样可以筛选出某个用户的具体行为,或者单独看登录前/登录后的用户行为。

aldSdk.setLoginId("登录 ald_login_id");

9.获取匿名ID

阿拉丁每个事件都会关联到一个 ID 上,用于标识该事件所对应的用户或设备信息,我们称之为 Distinct id,获取的是默认的 SDK 分配的匿名 ID(默认使用 AndroidId 作为匿名 ID) 您可以通过 getDistinctID() 方法获取 Distinct id:

aldSdk.getDistinctID();

10.调试查看事件信息

日志需要在原生 App开发软件中看,然后通过 Logcat 查看, Logcat 中筛选 Ald.UniModule关键词,埋点事件触发失败时,SDK 会输出相应的错误原因:

注:详情参考数据采集规范

隐私、权限声明

1. 本插件需要申请的系统权限列表:

<uses-permission android:name="android.permission.INTERNET" /> <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /> <uses-permission android:name="android.permission.READ_PHONE_STATE" /> <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

数据采集地址:https://slog.aldwx.com/d.html 采集数据用于指标,分析,报表全流程数据分析服务 隐私协议链接地址:https://eguayn27bz.feishu.cn/wiki/wikcnzJrzQZd5gQcqSU8Pm6IZgg

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

许可协议

作者未提供license.md

暂无用户评论。

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问