一、说明

1.适用范围

本文档适用于快应用监测业务，广告主可通过集成 TrackingIO 快应用 SDK 实现快应用内的事件统计，以及广告效果归因。

2.SDK下载

3.统计说明

为了能够在接入过程中保持概念统一，针对通用概念做如下说明：

  • 账号

指用户在浏览器中访问应用之后，在应用中的唯一标识。

通常用作账号的标识符可以是用户注册应用时的唯一用户名（如邮件地址），也可以是用户注册时自动生成的唯一字符串。

二、接入流程

1.申请APPKEY

1)打开https://www.new.trackingio.com，使用您的热云账号进行登录。

2)进入“产品中心”，点击左上方新建应用（选择快应用平台），完成产品创建，您将获得一串32位的16进制APPKEY；

如果您已经完成产品创建，请在如下位置获取APPKEY：全部产品按钮”-“对应产品”-APPKEY
APPKEY为应用的唯一标识，用于集成到SDK中。
注：为了保证您的数据安全,请勿泄露您的APPKEY。

2.导入SDK

1)前往最新SDK下载地址下载SDK压缩包，解压至本地目录。

2)通过以下方式将js文件引入到项目的入口文件中。

  • 完整引入
// app.ux
import TKIO from './TKIO.js'

TKIO.init('appkey')
  • 按需引入
// app.ux
import { init } from './TKIO.js'

init('appkey')

注：请务必在入口文件内正确引入sdk并调用 init 方法初始化，确保项目环境能访问到TrackingIO工具类。

3.接入SDK

详见“三、接入方法说明”

4.测试

1)进入热云调试页面查看调试数据：

“全部产品按钮” - “待调试产品”–“调试”

三、接入方法说明

1.初始化热云SDK

  • 方法用途：用户首次打开快应用时调用，一般建议在用户同意隐私协议，及用户权限后初始化。用于统计激活指标。

  • 方法接口：

TrackingIO.init(appkey, channelId, customParam)
  • 参数说明：
参数类型是否必填长度说明
appKeyString是固定32位创建产品时获得的32位字符长度的APPKEY
channelIdString是用于标识推广渠道，支持英文、数字、下划线，默认填写_default_；分包（应用市场）模式，该值必须与热云后台“配置”-“推广活动管理”-新建推广活动（分包）填写的渠道ID一一对应。
customParamObject否自定义属性key只能为string类型，名称为param1-param10，value支持字符串、数字。
  • 示例代码:
TrackingIO.init("70c9292372cd9e4cf32b67cf6e8a25f2", "Test_ChannelID_abc", { "customParams_1": "value" })

2.启动

  • 方法用途：

用户打开快应用时调用，用于统计留存类指标。

  • 方法接口：
TrackingIO.startup()
  • 参数说明：
    无
  • 示例代码:
TrackingIO.startup()

3.注册

  • 方法用途：

用户注册/表单提交成功后调用，注册成功后调用此方法,要确保accountId不能为空。用于统计注册类指标。

  • 方法接口：
TrackingIO.register(accountId, customParam)
  • 参数说明：
参数类型是否必填长度描述
accountIdString是最长64位账号唯一标识，支持英文、数字、下划线
customParamObject否自定义属性key只能为string类型，名称为param1-param10，value支持字符串、数字。
  • 示例代码:
TrackingIO.register("Test_accountId_abc", { "customParams_1": "value" })

4.登录

  • 方法用途：

用户登陆或切换账号操作成功后调用。用于统计登陆类指标及回流归因。

  • 方法接口：
TrackingIO.loggedin(accountId, customParam)
  • 参数说明:
参数类型是否必填长度描述
accountIdString是最长64位账号唯一标识，支持英文、数字、下划线
customParamObject否自定义属性key只能为string类型，名称为param1-param10，value支持字符串、数字。
  • 示例代码:
TrackingIO.loggedin("Test_accountId_abc", { "customParams_1": "value" })

5.订单

  • 方法用途：

用户在快应用内成功下单后调用。用于统计订单类指标。

  • 方法接口:
TrackingIO.order(transactionId, paymentType, currencyType, currencyAmount, customParam)
  • 参数说明:
参数类型是否必填长度说明
transactionIdString是最长64位订单流水号，请确保唯一。
paymentTypeString是最长16位支付类型，例如支付宝(alipay)，银联(unionpay)，微信支付（weixinpay）,易宝支付（yeepay），paymentType不能填写：FREE（FREE不统计付费）
currencyTypeString是最长3位货币类型，按照国际标准组织ISO 4217中规范的3位字母，例如CNY人民币、USD美金等
currencyAmountfloat是最长16位订单的真实货币金额，人民币单位：元
customParamObject否自定义属性key只能为string类型，名称为param1-param10，value支持字符串、数字。
  • 示例代码：
TrackingIO.order("Test_transactionId_abc", 200, "CNY", "Alipay", { "customParams_1": "value" })

6.付费

  • 方法用途：

用户在快应用内成功支付后调用。用于统计付费类、LTV类、ROAS类指标。

  • 方法接口：
TrackingIO.payment(transactionId, paymentType, currencyType, currencyAmount, customParam)
  • 参数说明：
参数类型是否必填长度说明
transactionIdString是最长64位交易流水号，请确保唯一。
paymentTypeString是最长16位支付类型，例如支付宝(alipay)，银联(unionpay)，微信支付（weixinpay）,易宝支付（yeepay），paymentType不能填写：FREE（FREE不统计付费）
currencyTypeString是最长3位货币类型，按照国际标准组织ISO 4217中规范的3位字母，例如CNY人民币、USD美金等
currencyAmountfloat是最长16位支付的真实货币金额，人民币单位：元
customParamObject否自定义属性key只能为string类型，名称为param1-param10，value支持字符串、数字。
  • 示例代码：
TrackingIO.payment("Test_transactionId_abc", 200, "CNY", "Alipay", { "customParams_1": "value" })

7.自定义事件

  • 方法用途：

需要统计任何其他自定义事件时，调用此方法，TrackingIO提供了30个自定义事件埋点位，所填eventName必须为event_1到event_30。用于自定义事件类指标、关键行为回调。

  • 方法接口：
TrackingIO.event(eventName, accountId, customParam)
  • 参数说明:
参数类型是否必填长度描述
eventNameString是自定义事件名称，必须为event_1到event_30
accountIdString是最长64位账号唯一标识，支持英文、数字、下划线
customParamObject否自定义属性key只能为string类型，名称为param1-param10，value支持字符串、数字。
  • 示例代码:
TrackingIO.event("event_1", "Test_accountId_abc", { "customParams_1": "value" })

技术支持

如有任何问题，请及时联系我们的技术支持工程师：

  • 技术支持邮箱：support@reyun.com
  • 技术支持QQ：2785608528