更新记录

1.0.6(2026-06-10)

【重要提醒】当前插件仅支持iOS;我的另一个插件JQ-RangersAppLog-UTS支持Android/iOS,UTS接入更方便,价格与当前插件一致。新项目建议优先使用JQ-RangersAppLog-UTS。

1.0.5(2025-07-14)

更新巨量广告转化融合归因优化方案接入手册(非游)V2.0中的 IOS最新SDK版本 :1.0.5

1.0.4(2025-03-31)

更新最新版本巨量广告转化融合归因优化方案接入手册V2.0 更新最新iOS sdk:1.0.3 添加AppStore上架隐私协议规范

查看更多

平台兼容性

Android iOS
× 适用版本区间:12 - 17

原生插件通用使用流程:

  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原生插件配置”->”云端插件“列表中删除该插件重新选择


重要提示:本插件是老版 iOS 原生语言插件,仅支持 iOS。现在已经发布新版 UTS 插件「巨量融合归因SDK UTS版」,插件 ID:JQ-RangersAppLog-UTS,地址:https://ext.dcloud.net.cn/plugin?id=28231 。新版同时支持 iOS 和 Android,基于 uni_modules / UTS API 接入,使用更方便,价格与当前插件一致,建议新项目优先使用新版 UTS 插件;老项目如果只需要 iOS 且已经稳定接入,可以继续使用本插件。

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

插件介绍

测试了 iOS 所有流程完全可用(包括打包真机 App Store 正式上架),并且 API 与 iOS 文档一致,直接看 iOS 文档也可上手。

  1. 该插件封装了巨量广告移动应用 SDK iOS SDK,SDK 版本号为融合归因 SDK iOS 1.0.5 版本,对应 V2 巨量引擎转化融合归因优化方案。
  2. 实现了巨量引擎转化 SDK 中的常用事件能力。

巨量广告 iOS SDK 文档地址:iOS SDK 地址

巨量广告移动应用 SDK 官网文档:https://open.oceanengine.com/labels/7/docs/1696710651039744

注意事项

  1. 本人有测试账号,并且对接了 iOS SDK 文档中的 API,亲测有效。使用方式比较简单,可参考 iOS 官方文档和示例工程。
  2. 提供 demo,可参考下面的使用指南进行 iOS 真机打包,并查看所有 API 调用示例。
  3. 如果你的项目需要同时支持 Android / iOS,或希望使用 uni_modules / UTS API 方式接入,建议优先使用新版插件:巨量融合归因SDK UTS版,价格与当前插件一致。

担心无法使用的同学请先试用查看功能是否正常,再进行购买!!!巨量引擎转化 SDK 中 iOS SDK 可能随时更新,如果遇到注册、付费无法回传等问题,请先参考巨量官方 iOS SDK 文档、巨量后台检测结果和本插件当前接入版本。

巨量广告移动应用 SDK 巨量引擎转化融合归因优化官网文档:巨量广告转化融合归因优化方案接入手册(非游)V2.0

使用指南

  • 使用方式与巨量 iOS SDK 文档基本一致,插件也提供了工具函数,可以参考示例工程。
  • 支持直接初始化、启动事件上报、DeepLink clickid 采集、IDFA 开关、可选参数采集、注册事件、付费事件、自定义事件上报等。

4.2.1.2 SDK 使用方式(必要)

// 1. 获取插件类
const module = uni.requireNativePlugin("JQ-RangersAppLog-AppModule")

启动事件上报可以通过下面三种方式任意一种方案:

// 1. 通过 uid 和默认选项初始化
// uid 是业务内部的用户 uid,非必传。如果传了,后续巨量可根据 uid 做相关逻辑,例如 uid 维度去重。
module.configAppUid('0000')
// 2. 通过 configApp 传入配置选项初始化
module.configApp({
  uid: '你的uid',
  channel: 'App Store'
})
// 3. 通过 setupAppLog 初始化
module.setupAppLog({
  uid: '625692',
  channel: 'App Store',
  abEnable: true,
  autoTrackEnabled: true,
  showDebugLog: true,
  clearABCacheOnUserChange: true,
  logNeedEncrypt: true,
  gameModeEnable: true
}, (cal) => {
  console.log(cal)
})

上报成功验证:启动事件上报成功后会打印 console 日志,具体数据可在巨量官方检测工具或后台查看。

获取 IDFA

SDK 内部对 IDFA 获取使用开关控制,默认不获取 IDFA。如果需要获取 IDFA,可通过以下方式设置。请先完成 Apple ATT 合规和用户授权。

module.enableIdfa(true)

DeepLink clickid 采集

插件已实现 clickid 采集。这里获取的 clickid 需要其他 App 通过 DeepLink 方式打开本 App 时才能获取到值。

module.getClickId((clickId) => {
  console.log(clickId)
})

延时上报

// 开启延时上报
module.enableDelayUpload()

// 允许数据上报
module.startSendingEvents()

可选参数采集

官方 SDK 的 kBDADSignalSDKUserUniqueId 与插件的 uid key 是一致的,传入插件后会把 uid 转换为 kBDADSignalSDKUserUniqueId

module.registerWithOptionalData({
  uid: '3y48693232',
  extra_param: 'xxx'
})

自定义事件上报

注册事件:

module.registerEvent({
  name: 'xxx'
})

付费事件:

module.purchaseEvent({
  type: '电子商品',
  name: 'imac一体机',
  contentID: '543309',
  number: 1,
  channel: 'wechat',
  currency: '¥',
  amount: 9000,
  isSuccess: true
})

也可以通过自定义上报实现注册、支付、停留时长等行为,需要实现 event_id 对应 SDK 中的事件名字。

module.trackEssentialEvent({
  event_id: 'purchase',
  type: '电子商品',
  name: 'imac一体机',
  contentID: '543309',
  number: 1,
  channel: 'wechat',
  currency: '¥',
  amount: 9000,
  isSuccess: true
})

module.trackEssentialEvent({
  event_id: 'stay_time',
  type: 'xxx',
  name: 'xxx一体机'
})

module.trackEssentialEvent({
  event_id: 'xxx',
  type: 'xxx'
})

归因参数说明

广告主需要额外从客户端采集:IDFV、clickid。clickid 可通过 SDK 提供的接口获取;如果已经在使用 DeepLink,可以添加 __CLICKID__ 宏参自动拼接。

  • IDFA 请参考上面文档,默认不开启。
  • clickid 默认已集成。
  • 其他 iOS SDK 文档中的 API 与本插件保持一致。

新版 UTS 插件说明

新版插件:巨量融合归因SDK UTS版

  • 插件 ID:JQ-RangersAppLog-UTS
  • 支持平台:Android / iOS
  • 接入方式:uni_modules / UTS API
  • 优点:同时支持双端,API 更统一,适合新项目和需要 Android 支持的项目。

隐私、权限声明

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

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

插件使用的巨量 SDK 上报数据会采集数据,详情可参考:

  • https://bytedance.larkoffice.com/docx/CgYBdVzoBogND2xv7PhcSfFNnyc
  • https://bytedance.larkoffice.com/docx/IuNld5X23o9ehbxwrhXc6QLbnZc

上报成功验证:启动事件上报成功后会打印 console 日志,参见 Utilities/BDASignalUtility.m

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

隐私、权限声明

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

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

插件使用的 巨量SDK上报数据 会采集数据,详情可参考:https://bytedance.larkoffice.com/docx/CgYBdVzoBogND2xv7PhcSfFNnyc 巨量引擎转化SDK开发者使用合规规范:https://bytedance.larkoffice.com/docx/IuNld5X23o9ehbxwrhXc6QLbnZc 上报成功验证 启动事件上报成功后会打印console日志,参见Utilities/BDASignalUtility.m

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