Wap/H5_SDK_接入说明文档

一、说明

1.适用范围

热云TrackingIO作为国内第三方移动广告监测平台，能够更好的帮助广告主更精准的评估每次广告投放效果，以及帮助广告网络做广告系统的投放优化或业务数据的完善。

本文档适用于使用浏览器访问的产品。

2.统计说明

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

账号

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

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

二、接入流程

1.申请APPKEY

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

2)进入“产品中心”，点击左上方“+新建产品”，完成产品创建，您将获得一串32位的16进制APPKEY；

如果您已经完成产品创建，请在如下位置获取APPKEY：全部产品按钮”-“对应产品”-APPKEY

APPKEY为应用的唯一标识，用于集成到SDK中。

注：为了保证您的数据安全,请勿泄露您的APPKEY。

2.导入SDK

1)前往http://doc.trackingio.com/sdkwen-dang.html下载SDK压缩包，解压至本地目录。

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

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

3.接入SDK

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

4.测试

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

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

三、接入方法说明

1.初始化热云SDK

方法用途：

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

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

方法接口：

TrackingIO.init(appkey)

参数说明：

参数	类型	是否必填	长度	说明
appKey	String	是		创建产品时获得的32位字符长度的APPKEY

示例代码:

TrackingIO.init(“475938c702f7451a88eaffb524962649”)

2.统计用户注册数据

方法用途：

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

方法接口：

TrackingIO.register(accountId,params)

参数说明：

参数	类型	是否必填	长度	描述
accountId	String	是	最长64位	账号唯一标识，支持英文、数字、下划线
params	json	否		自定义属性key只能为string类型，需要以英文字符开头，仅支持输入英文字符、数字、下划线；以“_”开头为内置属性，不可以使用。value支持字符串、数字、日期和布尔类型。

示例代码:

TrackingIO.register(“[email protected]”,{“age”:20})

3.统计用户登录数据

方法用途：

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

方法接口：

TrackingIO.loggedin(accountId,params)

参数说明:

参数	类型	是否必填	长度	描述
accountId	String	是	最长64位	账号唯一标识，支持英文、数字、下划线
params	json	否		自定义属性key只能为string类型，需要以英文字符开头，仅支持输入英文字符、数字、下划线；以“_”开头为内置属性，不可以使用。value支持字符串、数字、日期和布尔类型。

示例代码:

TrackingIO.loggedin(“[email protected]”)

4.统计用户下单数据

方法用途：

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

方法接口:

TrackingIO.order(transactionid,params)

参数说明:

参数	类型	是否必填	长度	描述
transactionId	string	是	最长64位	交易流水号，请确保唯一。
params	json	否		自定义属性key只能为string类型，需要以英文字符开头，仅支持输入英文字符、数字、下划线；以“_”开头为内置属性，不可以使用。value支持字符串、数字、日期和布尔类型。类型。

示例代码:

TrackingIO.order(“14213123123123”)

5.统计用户付费数据

方法用途：

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

方法接口：

TrackingIO.payment (transactionid,currencyamount,currencytype,paymenttype,params)

参数说明：

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

示例代码：

TrackingIO.payment(“123”,200,”CNY”,” alipay”)

6.下载

方法用途：

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

方法接口:

TrackingIO.download(params)

参数说明:

参数	类型	是否必填	长度	描述
params	json	否		自定义属性key只能为string类型，需要以英文字符开头，仅支持输入英文字符、数字、下划线；以“_”开头为内置属性，不可以使用。value支持字符串、数字、日期和布尔类型。

示例代码:

TrackingIO.download()

wap/h5_接入文档说明