WAP/H5_SDK_接入说明文档
一、说明
1.适用范围
热云灵犀产品作为国内多维度的用户行为分析平台，能够更好的帮助客户精细化了解用户、寻找增长点、搭建多维数据分析模型，帮客户实现数据驱动。
本文档适用于以浏览器访问的产品。
2.统计说明
为了能够在接入过程中保持概念的统一,针对一些通用的概念做如下说明:
- 账号
指用户在某一台设备上安装了应用之后,在应用中的唯一标识符,通常可
以用作账号的标识符可以是用户注册应用时的唯一用户名,例如邮件地址,也可以是应用在用户注册时为用户自动生成相对应的唯一字符串。
二、接入流程
第一步、申请APP KEY
1)打开http://io.reyun.com/login.html，使用您的热云灵犀账号进行登录。
2)进入“产品中心”，点击左上方“+新建产品”，完成产品创建，您将获得一串32位的16进制APPKEY；
如果您已经完成产品创建，请在如下位置获取APPKEY：“全部产品按钮”-“对应产品”-APPKEY
3)APPKEY为应用的唯一标识，用于集成到SDK中。
注：为了保证您的数据安全,请勿泄露您的APPKEY。
第二步、接入SDK
1)前往http://iodoc.reyun.com/sdkwen-dang.html下载SDK压缩包，解压至本地目录。
2)以<script></script>方式引入到项目中，一般放入到公用头部，确保项目环境能访问到TrackingIO工具类。
注：
热云SDK所提供所有接口API的http response均以status : 0表示成功，若不成功，会在返回json里提示具体错误信息。
三、接入方法说明
1.初始化热云 SDK
- 方法用途:
页面开始加载前，初始化热云 SDK，传入appkey。
注：在<head>里面引入和调用，页面有sdk的引入，都必须调用此方法。
- 方法接口:
io.init(appkey)
- 参数说明:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| appKey | string | 是 | 填写在热云TrackingIO系统创建应用时获得的 32个字符长度的 appkey |
- 示例代码:
io.init(“475938c702f7451a88eaffb524962649”)
2.统计用户注册数据
- 使用方法:
当有新用户注册时，注册成功后调用此方法,要确保accountId不能为空。
- 方法接口:
io.register(accountId,params)
- 参数说明:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| accountId | string | 是 | 设定账号的唯一标识 ID |
| params | json | 否 | 自定义属性, key只能是string类型，需要以英文字符开头，仅支持输入英文字符、数字、下划线；以“_”开头为内置属性，不可以使用。value目前支持字符串、数字、日期和布尔类型。 |
- 示例代码:
io.register(“[email protected]”,{“age”:20})
3.统计用户登陆数据（每次进入服务器）
- 使用方法:
当用户有登陆、切换账号操作时调用此方法。
- 方法接口:
io.loggedin(accountId,params)
- 参数说明:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| accountId | string | 是 | 设定账号的唯一标识 ID |
| params | json | 否 | 自定义属性, key只能是string类型，需要以英文字符开头，仅支持输入英文字符、数字、下划线；以“_”开头为内置属性，不可以使用。value目前支持字符串、数字、日期和布尔类型。 |
- 示例代码:
io.loggedin(“[email protected]”)
4.统计用户的付费数据
- 方法用途:
用户在应用中付费成功后,进行统计付费数据,所有付费相关分析的数据报表均依赖此方法。
- 使用方法:
在用户付费成功后调用此方法。
- 方法接口:
io.payment (transactionid,currencyamount,currencytype,paymenttype,params)
- 参数说明:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| transactionId | string | 是 | 交易的流水号,最长64个字符 |
| currencyAmount | float | 是 | 支付的真实货币的金额,最长16个字符,人民币的单位是元 |
| currencyType | string | 是 | 货币类型,按照国际标准组织ISO 4217中规范的3位字母,例如CNY人民币、USD美金等 |
| paymentType | string | 是 | 支付类型，例如支付宝(alipay)，银联(unionpay)，微信支付（weixinpay）,易宝支付（yeepay），最多16个字符，如果是,系统赠送的paymentType为：FREE |
| params | json | 否 | 自定义属性, key只能是string类型，需要以英文字符开头，仅支持输入英文字符、数字、下划线；以“_”开头为内置属性，不可以使用。value目前支持字符串、数字、日期和布尔类型。 |
- 示例代码:
io.payment(“123”,200,”CNY”,” alipay”)
5．下载
- 使用方法:
当用户下载应用时等操作，调用此方法。
- 接口说明:
io.download(params)
- 参数说明:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| params | json | 否 | 自定义属性，key只能是string类型，需要以英文字符开头，仅支持输入英文字符、数字、下划线；以“_”开头为内置属性，不可以使用。value目前支持字符串、数字、日期和布尔类型。 |
- 示例代码:
io.download()
6.统计用户的自定义事件
- 方法用途:
✓开发者可以自由的统计用户在应用内的任意用户行为，例如打开某个面板，点击某个Button，参与某个活动等。
✓eventName只能是合法的字符，包括英文字母、数字和下划线。
✓开发者调用此方法后，即可在热云的TrackingIO平台使用多维分析的强大功能。
- 使用方法:
在您希望进行用户行为统计的地方，调用此方法。
- 方法接口:
io.event(eventName,params)
- 参数说明:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| eventName | string | 是 | 自定义事件的名称 |
| params | json | 否 | 自定义属性，key只能是string类型，需要以英文字符开头，仅支持输入英文字符、数字、下划线；以“_”开头为内置属性，不可以使用。value目前支持字符串、数字、日期和布尔类型。 |
- 示例代码:
io.event(“openshoppingcar”,{“address”:”朝阳区”})
7.统计用户的profile
- 方法用途:
用于统计用户的profile信息。
- 使用方法:
在您希望进行用户profile信息统计的地方，调用此方法。
- 方法接口:
io.profile(params)
- 参数说明
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| params | json | 否 | key支持英文、数字、下划线。value支持字符串、数字、日期、布尔类型。注：以“_”开头的属性为内置属性；自定义属性不可添加“_”。 |
- 用户属性
| 通用用户属性 | key:value | 数据类型 |
|---|---|---|
| 用户名 | "_name":"李明" | NSString |
| 昵称 | "_nickname":"小明" | NSString |
| 生日 | "_birthday":"1988-11-11" | NSString |
| 性别 | "_gender":"男" | NSString |
| 婚姻状况 | "_marital_status":"未婚" | NSString |
| 家乡 | "_hometown":"北京" | NSString |
| 职业 | "_profession":"程序员" | NSString |
| 行业 | "_industry":"IT" | NSString |
| 学校 | "_school":"清华大学" | NSString |
| 学历 | "_degree":"本科" | NSString |
| 手机号 | "_tel":"13000000000" | NSString |
| 身份证号 | "_citizen_id":"330328194812280616" | NSString |
| 邮箱 | "_email":"[email protected]" | NSString |
| 微信 | "_wechat":"3782173321" | NSString |
| 微博 | "_weibo":"dsahiduwqio" | NSString |
| "_qq":"12345" | NSString | |
| 第一语言 | "_first_language":"汉语" | NSString |
| 城市 | "_city":"长沙" | NSString |
| 省份 | "_province":"湖南" | NSString |
| 国家 | "_country":"中国" | NSString |
| 来源 | "_source":"爱奇艺DSP" | NSString |
| 自定义用户属性 | ||
| 爱好 | "hobby":"音乐" | NSString |
- 示例代码:
io.profile({“_city”:”北京”})
四、技术支持
如果您有任何问题，我们的技术支持工程师会第一时间给您提供帮助，
可以通过如下方式联系：
技术支持邮箱：[email protected]
技术支持QQ：2785608528