更新记录

2.0.0(2026-06-04)

  • 新增 UTS API 插件版本,插件 ID 为 JQ-RangersAppLog-UTS。
  • iOS 接入 BDASignalSDK 2.0.0,支持初始化、IDFA 开关、DeepLink clickid、关键事件、延迟上报、IAP 监听。
  • Android 接入 AppConvert 2.0.4,支持初始化、注册事件、付费事件和自定义事件上报。
  • 提供老版 JQ-RangersAppLog 常用接口兼容层,并补充 Android/iOS 示例工程和隐私说明。

平台兼容性

uni-app(5.07)

Vue2 Vue3 Chrome Safari app-vue app-nvue Android iOS 鸿蒙
× × × 5.0 15 ×
微信小程序 支付宝小程序 抖音小程序 百度小程序 快手小程序 京东小程序 鸿蒙元服务 QQ小程序 飞书小程序 小红书小程序 快应用-华为 快应用-联盟
× × × × × × × × × × × ×

uni-app x(5.07)

Chrome Safari Android iOS 鸿蒙 微信小程序
× × 5.0 15 × ×

巨量融合归因SDK UTS版

JQ-RangersAppLog-UTS 是全新的 uni_modules / UTS API 插件,用于接入巨量营销融合归因优化方案(非游)V2.0。

本插件已按《巨量营销融合归因优化方案接入手册(非游)V2.0》完成 Android / iOS 双端 UTS 对接,并已完成云打包、iOS 真机、Android 真机流程验证;初始化、DeepLink / clickid、注册事件、付费事件、关键事件、老接口兼容调用均已在示例工程中提供。

担心无法使用的同学请先试用,确认自定义基座 / 云打包 / 真机功能正常后再购买。巨量引擎转化 SDK 版本可能随官方文档随时更新,购买和上线前请以本插件当前版本、试用结果、巨量官方文档和巨量后台检测结果为准。

插件介绍

  1. 本插件封装巨量引擎转化融合归因 Android / iOS SDK,适合 uni-app / uni-app x 项目通过 UTS 接入巨量广告归因、转化上报、注册上报、付费上报、关键事件上报。
  2. iOS 基于 BDASignalSDK 2.0.0,最低 iOS 15.0,支持隐私同意后初始化、IDFA 开关、DeepLink clickid 解析、启动参数缓存、关键事件上报。
  3. Android 基于 com.bytedance.ads:AppConvert:2.0.4,最低 Android API 21,支持 BDConvert 初始化、注册事件、付费事件、自定义事件上报和 BDBridgeActivity 归因跳转配置。
  4. 老版原生插件用户可以继续使用 configAppUidconfigAppsetupAppLogregisterEventpurchaseEvent 常用接口;新项目建议直接使用 initBDASDKtrackRegistertrackPurchasetrackEssentialEvent 等 UTS API。
  5. 普通授权价格 198.00 元,不开放源码授权。

巨量官方文档地址:

已验证

  • iOS:HBuilderX 5.07 云打包后,iPhone 真机验证初始化、原生状态、DeepLink clickid、注册事件、付费事件、老接口兼容调用均可正常执行。
  • Android:HBuilderX 5.07 云打包 APK 后,Android 真机验证初始化、注册事件、付费事件、老接口兼容调用均可正常执行。
  • Android 已按 AppConvert 2.0.4 AAR 公开 API 对接 BDConvert 初始化、ConvertReportHelper 注册/付费/自定义事件。
  • iOS 已将 SDK 调用切到主线程,避免 BDASignalSDK 内部初始化 WKWebView 时因后台线程触发闪退。
  • Android AppConvert 2.0.4 未公开 optionalData/user_unique_id 注入和 clickid getter 等等价接口,插件会返回 warning 提醒;这不影响初始化和注册/付费/自定义事件上报,最终转化归因仍需按巨量融合归因方案完成服务端 API 回传并以巨量后台检测为准。

安装

  1. 将插件导入到项目的 uni_modules/JQ-RangersAppLog-UTS
  2. App 端需要重新生成自定义基座或云打包,不能只使用 HBuilderX 默认标准基座。
  3. 请在用户同意隐私政策后再调用 initBDASDK

iOS 原生配置:

{
  "deploymentTarget": "15.0",
  "validArchitectures": ["arm64"],
  "dependencies-pods": [
    {
      "name": "BDASignalSDK",
      "version": "2.0.0"
    }
  ]
}

Android 原生配置:

{
  "minSdkVersion": 21,
  "dependencies": ["com.bytedance.ads:AppConvert:2.0.4"],
  "project": {
    "repositories": [
      "maven { url 'https://artifact.bytedance.com/repository/Volcengine/' }"
    ]
  }
}

快速开始

import {
  initBDASDK,
  getDebugStatus,
  getClickId,
  handleOpenURL,
  trackRegister,
  trackPurchase,
  trackEssentialEvent
} from '@/uni_modules/JQ-RangersAppLog-UTS'

// 用户同意隐私政策后调用
const initResult = initBDASDK({
  enableIdfa: false, // 仅 iOS 生效
  enableLog: true,   // Android AppConvert 调试日志
  optionalData: {
    user_unique_id: 'user_10001' // iOS 生效;Android AppConvert 未公开该注入接口
  },
  enableIPFetch: true
})

console.log(initResult)
console.log(getDebugStatus())

// iOS 支持解析并读取 clickid
handleOpenURL('yourapp://open?clickid=xxx')
console.log('clickid', getClickId())

trackRegister({
  registerType: 'mobile',
  success: true
})

trackPurchase({
  goodsType: 'digital',
  goodsName: 'vip',
  goodsId: 'A1001',
  goodsNum: 1,
  payChannel: '***',
  currency: 'CNY',
  success: true,
  amount: 68
})

trackEssentialEvent('add_to_cart', {
  source: 'demo'
})

隐私与合规

  • 插件不展示广告,也不会主动弹出权限申请。
  • iOS BDASignalSDK 可能采集 IDFV、设备信息、系统信息、网络信息、应用信息、DeepLink clickid、调用方传入的 user_unique_id / extra 参数。
  • Android AppConvert 可能采集 Android ID、OAID、设备信息、系统信息、网络信息、应用信息、广告点击/转化归因信息、调用方主动传入的事件参数。
  • Android SDK 自带 INTERNETACCESS_NETWORK_STATECHANGE_NETWORK_STATE 等网络相关声明,并包含用于归因跳转的 BDBridgeActivity
  • iOS IDFA 默认不采集。若业务需要 IDFA,请先在应用中配置 NSUserTrackingUsageDescription,完成 ATT 合规授权后再调用 enableIdfa(true)initBDASDK({ enableIdfa: true })
  • 建议在用户同意隐私政策后再调用 initBDASDK
  • 融合归因方案中的注册、付费等转化效果通常还需要按巨量引擎后台要求完成服务端 API 回传,最终归因结果以巨量引擎后台和官方文档为准。

API

initBDASDK(options?)

初始化 SDK。建议在隐私同意后调用。

initBDASDK({
  enableIdfa: false,
  optionalData: {
    user_unique_id: 'user_10001'
  },
  enableLog: true,
  enableOAID: true,
  autoSendLaunchEvent: true,
  playSessionEnable: true
})

options 字段:

字段 平台 说明
enableIdfa iOS 是否允许 SDK 采集 IDFA,请先完成 ATT 合规。
optionalData iOS 可选归因参数,常用 user_unique_id。兼容老字段 uid
enableLog / showDebugLog Android 是否开启 AppConvert 调试日志。
enableOAID / enableOaid Android 是否允许 AppConvert 采集 OAID,默认 true。
enableIPFetch / enableIpFetch Android 是否允许 AppConvert 获取 IP 相关信息。
autoSendLaunchEvent Android 初始化后是否自动上报启动事件,默认 true。
playSessionEnable Android 是否开启 session 生命周期统计,默认 true。

enableIdfa(enable)

iOS 设置 SDK 是否允许采集 IDFA。Android 调用会返回 warning,不会做实际操作。

registerOptionalData(data)

iOS 向 BDASignalSDK 注入可选参数。Android AppConvert 未公开等价接口,调用会返回 warning。

getClickId()

iOS 获取 SDK 缓存的 clickid。Android AppConvert 2.0.4 未公开 clickid getter,返回空字符串。

handleOpenURL(url)

iOS 解析 URL Scheme 或 Universal Link 中的 clickid。Android 归因点击由 AppConvert 内部和 BDBridgeActivity 处理,未公开手动解析接口。

trackRegister(params?)

注册事件。

Android 会映射到:

ConvertReportHelper.onEventRegister(registerType, success)

插件实际调用 AppConvert 2.0.4 的 extra 参数重载,会把传入的 params 同时作为 JSONObject 透传给 SDK。

常用参数:

字段 说明
registerType / method 注册方式,默认 default
success / is_success 是否成功,默认 true。

trackPurchase(params?)

付费事件。

Android 会映射到:

ConvertReportHelper.onEventPurchase(goodsType, goodsName, goodsId, goodsNum, payChannel, currency, success, amount, ttOpenId, extra)

插件会把传入的 params 同时作为 JSONObject 透传给 SDK。

常用参数:

字段 说明
goodsType / content_type / type 商品类型。
goodsName / content_name / name 商品名称。
goodsId / content_id / contentID / order_id 商品或订单 ID。
goodsNum / content_num / number 商品数量。
payChannel / payment_channel / channel 支付渠道。
currency 币种,默认 CNY
success / isSuccess 是否成功,默认 true。
amount / currency_amount 金额。
tt_open_id / ttOpenId 抖音开放平台 open id,可选。

trackEssentialEvent(eventName, params?)

iOS 调用 BDASignalSDK 关键事件接口;Android 调用 ConvertReportHelper.onEventV3(eventName, JSONObject)

常用快捷方法:

trackRegister({ registerType: 'mobile', success: true })
trackPurchase({ goodsName: 'vip', amount: 68 })
trackStayTime({ seconds: 30 })
trackGameAddiction({ value: 1 })

常用事件名:

事件名 说明
stay_time 停留时长
register 注册
purchase 付费
game_addiction 游戏防沉迷相关事件
achieve_level 达到等级
add_payment_info 添加付款信息
add_to_wishlist 添加收藏/愿望清单
checkout 准备结账
complete_tutorial 完成教程
create_group 创建群组/团队
create_role 创建角色
generate_lead 留资
in_app_ad_click 应用内广告点击
in_app_ad_impression 应用内广告展示
add_to_cart 加入购物车
join_group 加***组/团队

enableDelayUpload() / startSendingEvents()

iOS 生效。Android AppConvert 未公开延迟上报接口,调用会返回 warning。

enablePurchaseEvent()

iOS IAP 监听生效。Android 请在业务付费成功后主动调用 trackPurchase

老接口兼容

import {
  configAppUid,
  configApp,
  setupAppLog,
  registerEvent,
  purchaseEvent
} from '@/uni_modules/JQ-RangersAppLog-UTS'

configAppUid('user_10001')
configApp({ uid: 'user_10001', showDebugLog: true })

setupAppLog({
  uid: 'user_10001',
  showDebugLog: true
}, (res) => {
  console.log(res)
})

registerEvent({ registerType: 'mobile', success: true })
purchaseEvent({ goodsName: 'vip', amount: 68 })

注意:setupAppLog 中老 RangersAppLog 独有配置项会被忽略,并返回 warning。融合归因接入以各平台 SDK 公开能力为准。

对接核对

官方接入项 插件实现
iOS CocoaPods 接入 BDASignalSDK 2.0.0 utssdk/app-ios/config.json 已配置 dependencies-pods
iOS 最低 iOS 15.0、arm64 已配置 deploymentTarget: 15.0validArchitectures: arm64
iOS 可选参数 registerOptionalData / initBDASDK({ optionalData }) 调用 registerWithOptionalData:
iOS 冷启动事件 initBDASDK 后调用 didFinishLaunchingWithOptions:connectOptions:
iOS URL Scheme / Universal Link clickid iOS hook 缓存 URL,handleOpenURL 调用 anylyseDeeplinkClickidWithOpenUrl:
iOS 获取 clickid getClickId 调用 getClickId
iOS 关键事件上报 trackEssentialEvent 调用 trackEssentialEventWithName:params:
Android Maven 接入 AppConvert 2.0.4 utssdk/app-android/config.json 已配置 Volcengine 仓库和依赖
Android SDK 初始化 initBDASDK 调用 BDConvert.init(...)
Android 启动事件 默认由 AppConvert 初始化后 autoSendLaunchEvent 自动上报,可通过 options 控制
Android 注册事件 trackRegister 调用 ConvertReportHelper.onEventRegister
Android 付费事件 trackPurchase 调用 ConvertReportHelper.onEventPurchase
Android 自定义事件 trackEssentialEvent 调用 ConvertReportHelper.onEventV3

常见问题

为什么真机运行提示插件不存在或 undefined class

UTS 原生插件必须重新打自定义基座或云打包。HBuilderX 默认标准基座不包含你的 UTS 原生模块。

Android 为什么读取不到 clickid?

AppConvert 2.0.4 AAR 的公开 API 没有 getClickIdhandleOpenURL 方法。Android 点击归因由 SDK 内部和 BDBridgeActivity 处理,客户端无需也不能通过公开 API 读取 clickid;注册、付费等转化仍建议按巨量后台要求做服务端 API 回传。

初始化返回 nativeOk: true 是否代表 SDK 已接入?

代表 UTS 已经调用到对应平台原生 SDK。最终数据是否在巨量后台展示,还取决于网络、广告计划、转化配置、服务端回传和巨量后台处理。

发布信息

  • 插件 ID:JQ-RangersAppLog-UTS
  • 插件名称:巨量融合归因SDK UTS版
  • 版本:2.0.0
  • 分类:UTS插件 / API插件
  • 价格:普通授权 198.00 元,不开放源码授权
  • 关键词:巨量融合归因BDASignalSDKAppConvertAndroidiOSUTS

隐私、权限声明

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

插件本身不主动弹出系统权限申请。Android SDK 依赖会声明 INTERNET、ACCESS_NETWORK_STATE、CHANGE_NETWORK_STATE 等网络状态权限;如业务在 iOS 开启 IDFA,请应用自行配置 NSUserTrackingUsageDescription,并在用户授权后调用 enableIdfa(true)。

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

插件接入 iOS BDASignalSDK 和 Android AppConvert,用于巨量融合归因数据采集与转化上报。SDK 可能采集设备信息、系统信息、网络信息、应用信息、Android ID/OAID、IDFV、DeepLink/广告点击归因信息,以及调用方主动传入的事件参数;IDFA 仅在 iOS 调用方完成 ATT 合规并主动开启后采集。数据用于巨量广告归因、转化统计和投放优化,上传至巨量引擎/OceanEngine 相关官方 SDK 服务,具体服务地址以 SDK 实际版本请求和巨量官方文档为准。

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

无。插件不包含广告展示能力,不会在应用内展示广告。

暂无用户评论。