一、说明

1.适用范围

本文档适用于H5页面监测业务，广告主可通过集成TrackingIO JS SDK实现H5落地页内的事件统计，以及前端广告效果归因

2.SDK下载

3.统计说明

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

  • 账号

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

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

二、接入流程

1.申请APPKEY

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

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

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

2.导入SDK

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

2)通过方式将.js文件引入到项目中。

注：建议导入到公用头部，确保项目环境能访问到TrackingIO工具类。

3.接入SDK

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

4.测试

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

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

三、接入方法说明

1.初始化热云SDK

  • 方法用途：

页面开始加载前，初始化热云SDK。

注：在里面引入和调用，页面有sdk的引入，都必须调用此方法。

  • 方法接口：
TrackingIO.init(appkey)
  • 参数说明：
参数类型是否必填长度说明
appKeyString是创建产品时获得的32位字符长度的APPKEY
  • 示例代码:
TrackingIO.init(“475938c702f7451a88eaffb524962649”)

2.统计用户注册数据

  • 方法用途：

当有新用户注册/表单提交时，注册成功后调用此方法,要确保accountId不能为空。

  • 方法接口：
TrackingIO.register(accountId,params)
  • 参数说明：
参数类型是否必填长度描述
accountIdString是最长64位账号唯一标识，支持英文、数字、下划线
paramsjson否自定义属性key只能为string类型，需要以英文字符开头，仅支持输入英文字符、数字、下划线；以“_”开头为内置属性，不可以使用。value支持字符串、数字、日期和布尔类型。
  • 示例代码:
TrackingIO.register(“test@163.com”,{“age”:20})

3.统计用户登录数据

  • 方法用途：

当用户有登陆、切换账号操作时调用此方法。

  • 方法接口：
TrackingIO.loggedin(accountId,params)
  • 参数说明:
参数类型是否必填长度描述
accountIdString是最长64位账号唯一标识，支持英文、数字、下划线
paramsjson否自定义属性key只能为string类型，需要以英文字符开头，仅支持输入英文字符、数字、下划线；以“_”开头为内置属性，不可以使用。value支持字符串、数字、日期和布尔类型。
  • 示例代码:
TrackingIO.loggedin(“test@163.com”)

4.统计用户下单数据

  • 方法用途：

用户在应用中开始下单时,进行统计下单数据

  • 方法接口:
TrackingIO.order(transactionid,currencyamount,currencytype,paymenttype,params)
  • 参数说明:
参数类型是否必填长度说明
transactionIdString是最长64位订单流水号，请确保唯一。
paymentTypeString是最长16位支付类型，例如支付宝(alipay)，银联(unionpay)，微信支付（weixinpay）,易宝支付（yeepay），paymentType不能填写：FREE（FREE不统计付费）
currencyTypeString是最长3位货币类型，按照国际标准组织ISO 4217中规范的3位字母，例如CNY人民币、USD美金等
currencyAmountfloat是最长16位订单的真实货币金额，人民币单位：元
paramsjson否自定义属性key只能为string类型，需要以英文字符开头，仅支持输入英文字符、数字、下划线；以“_”开头为内置属性，不可以使用。value支持字符串、数字、日期和布尔类型。
  • 示例代码：
TrackingIO.order(“123”,200,”CNY”,” alipay”)

5.统计用户付费数据

  • 方法用途：

用于用户充值成功，统计充值数据，所有付费相关分析的数据报表均依赖此方法。

  • 方法接口：
TrackingIO.payment(transactionid,currencyamount,currencytype,paymenttype,params)
  • 参数说明：
参数类型是否必填长度说明
transactionIdString是最长64位交易流水号，请确保唯一。
paymentTypeString是最长16位支付类型，例如支付宝(alipay)，银联(unionpay)，微信支付（weixinpay）,易宝支付（yeepay），paymentType不能填写：FREE（FREE不统计付费）
currencyTypeString是最长3位货币类型，按照国际标准组织ISO 4217中规范的3位字母，例如CNY人民币、USD美金等
currencyAmountfloat是最长16位支付的真实货币金额，人民币单位：元
paramsjson否自定义属性key只能为string类型，需要以英文字符开头，仅支持输入英文字符、数字、下划线；以“_”开头为内置属性，不可以使用。value支持字符串、数字、日期和布尔类型。
  • 示例代码：
TrackingIO.payment(“123”,200,”CNY”,” alipay”)

6.下载

  • 方法用途：

当用户下载应用时等操作，调用此方法。

  • 方法接口:
TrackingIO.download(params)
  • 参数说明:
参数类型是否必填长度描述
paramsjson否自定义属性key只能为string类型，需要以英文字符开头，仅支持输入英文字符、数字、下划线；以“_”开头为内置属性，不可以使用。value支持字符串、数字、日期和布尔类型。
  • 示例代码:
TrackingIO.download()

7.自定义事件

  • 方法用途：

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

  • 方法接口：
TrackingIO.event(eventname,params)
  • 参数说明:
参数类型是否必填长度描述
eventNameString是自定义事件名称，必须为event_1到event_12
paramsjson否自定义属性key只能为string类型，需要以英文字符开头，仅支持输入英文字符、数字、下划线；以“_”开头为内置属性，不可以使用。value支持字符串、数字、日期和布尔类型。
  • 示例代码:
TrackingIO.event("event_1")

8.获取设备ID

  • 方法用途：

用于获取唯一设备标识符。
注：

1.当前设备ID由TrackingIO SDK生成，且用户清除缓存重新访问页面设备ID发生改变
2.如需使用服务端上报数据至TrackingIO调用该方法获取deviceid

  • 使用方法：
    调用getDeviceid方法，用以获取唯一设备标识符
  • 方法接口：
TrackingIO.getdeviceid()
  • 示例代码
var a = TrackingIO.getdeviceid()
console.log(a)

9.SDK自动统计的事件

  • finishload事件：统计首页加载完成率，与首页加载完成平均时间
  • appduration事件：统计页面浏览时长，与页面打开次数

技术支持

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

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