一、说明

1.适用范围

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

本文档适用于各版本的微信小程序。

2.SDK下载

下载地址
最新SDK版本为：1.0.4

3.统计说明

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

用户

指通过微信小程序接口，获取openid，代表访问设备在微信小程序的唯一标识，同一用户openid保持不变。

二、接入流程

1.申请APPKEY

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

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

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

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

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

2.导入SDK

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

2)通过import sdk from "utils/reyunwx.js"方式将.js文件引入到项目中。

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

3.接入SDK

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

4.微信后台配置热云request合法域名

接入过程中，在微信后台配置request合法域名，进入位置与获取APPID和AppSecre时一致，在设置-开发设置-服务器域名中添加。

点击修改，如果未曾设置过，点击配置即可弹窗内进行配置，如下。

5.测试

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

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

三、接入方法说明

1.初始化热云SDK

方法用途：

初始化热云SDK，需要在onshow方法或之前进行调用，否则影响该接口事件上报和后续归因，初始化以外后续接口事件需在该接口5s后进行调用。

openid获取提供两种方式：

第一种，部分客户由于某种功能上的影响需要自己提供openid，传入openid即可(再加appkey)。

方法接口：

sdk.init(appkey,openid,params);

参数说明：

参数	类型	是否必填	说明
appKey	String	是	创建产品时获得的32位字符长度的APPKEY
openId	String	是	用户唯一标识
params	Json	否	自定义属性key只能为string类型，需要以英文字符开头，仅支持输入英文字符、数字、下划线；以“_”开头为内置属性，不可以使用。value支持字符串、数字、日期和布尔类型

示例代码:

sdk.init(“475938c702f7451a88eaffb524962649”,“ogx2W5MPM0nJg2GheBxwcDZADiCE”,{“age”:20})

第二种，可以不传入openid，由SDK调用接口获取openid。只传appkey。

方法接口：

sdk.init(appkey,params);

参数说明：

参数	类型	是否必填	长度	说明
appKey	String	是		创建产品时获得的32位字符长度的APPKEY
params	Json	否		自定义属性key只能为string类型，需要以英文字符开头，仅支持输入英文字符、数字、下划线；以“_”开头为内置属性，不可以使用。value支持字符串、数字、日期和布尔类型

示例代码:

sdk.init(“475938c702f7451a88eaffb524962649”,{“age”:20})

2.统计用户注册数据

方法用途：

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

方法接口：

sdk.register(accountiId,params)

参数说明：

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

示例代码:

sdk.register(“test@163.com”,{“age”:20})

3.统计用户登录数据

方法用途：

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

方法接口：

sdk.loggedin(accountId)

参数说明:

参数	类型	是否必填	长度	描述
accountId	String	是	最长64位	账号唯一标识，支持英文、数字、下划线

示例代码:

sdk.loggedin(“test@163.com”)

4.统计用户付费数据

方法用途：

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

方法接口：

sdk.payment (transactionid,currencyamount,currencytype,paymenttype)

参数说明：

参数	类型	是否必填	长度	说明
transactionId	String	是	最长64位	交易流水号，请确保唯一。
currencyAmount	float	是	最长16位	支付的真实货币金额，人民币单位：元
currencyType	String	是	最长3位	货币类型，按照国际标准组织ISO 4217中规范的3位字母，例如CNY人民币、USD美金等
paymentType	String	是	最长16位	支付类型，例如支付宝(alipay)，银联(unionpay)，微信支付（weixinpay）,易宝支付（yeepay），paymentType不能填写：FREE（FREE不统计付费）

示例代码：

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

5.统计自定义事件

方法用途：

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

方法接口：

TrackingIO.event(eventname,params)

参数说明:

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

示例代码:

TrackingIO.event("event_1",{“age”:20})

6、技术支持

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

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

3.微信小程序_接入说明文档