介绍

smart_web_data_sdk 是一个智能的web端大数据库，集成了数据采集、A/B 测试、机器学习。

服务端项目地址

https://github.com/534591395/smart_web_data_sdk ［点击查看］（https://github.com/534591395/smart_web_data_sdk） 当前作者正在本地开发调试中

数据采集
提供了大数据web端的数据采集功能，采集数据方式提供了代码埋点、可视化埋点、热力图，采集的数据类型多量化。

A/B测试
web端的A/B测试有三种实验类型：编程实验、多链接实验、可视化实验。本库分别提供了这三种实验类型的拉取配置后的解决方案，同时也提供了可视化实验的可视化配置实现插件。

机器学习
采集到数据后，机器学习训练好的模型用在web端，sdk提供了解决方案，探索前端的智能化。

运行

1. 首先 npm install 或 cnpm install ，拉取必须包。
2. sdk打包命名：npm run build，运行后将在build文件夹下生成执行文件包。
3. 运行示例：运行命令 npm run server，后，首次访问 http://localhost:3300/example/index.html，浏览器调试下可查看到依次触发了用户首次访问网站事件（smart_activate）、会话开始事件（smart_session_start）、PV事件（smart_pv）。

采集库开发文档

初始化

首先页面header头部引入sdk代码，参考示例，然后初始化sdk，并传入token以及设置配置。

默认：

smart.init('token-xxx');

设置配置

smart.init('token-xxx',{
  local_storage: {
    type: 'localStorage'
});

注意：配置项说明暂请查看 src/config.js文件中的 DEFAULT_CONFIG 类，里面有详细注解说明。

代码埋点

1. smart.track_pv()

默认情况下，sdk内部是自动触发PV事件的，若想手动触发，请调用该方法（注意先配置停止自动触发PV事件）。

禁止自动触发PV事件配置

smart.init('xxx', {
  pageview: false
});

2. smart.track_event()

需要上报自定义事件，请调用该方法。参数详细说明请查看 src/main.js 文件中的 track_event 方法注解。

示例：

smart.track_event("buy",{"price":"￥123", "id": 'xxxx-xxxx-xxxx'});

3. smart.user.set()

需要自定义用户属性，请调用该方法。参数详细说明请查看 src/user_track.js 文件中的 set 方法注解。

示例：

smart.user.set({ "name": "白云飘飘","country":"中国","province":"浙江省","city":"杭州市","age":"100","gender":"男", "niu":"自定义用户属性" });

4. 启动单页面

单页面监听PV事件，需启动单页面，然后设置实现的技术手段（当前支持 hash、history）

a. 启动

smart.init('xxx', {
  SPA: {
    // 设置为true，表示启动
    is: true,
    // 使用的技术手段 hash or history
    mode: 'hash'
  }
});

b. 单页面触发时监听

smart._.innerEvent.on('singlePage:change', function(eventName, urlParams) {
  console.log(urlParams)
  // urlParams: { nowUrl: 'xxx', oldUrl: 'xxx' }
});

5. smart.time_event()

统计事件耗时(ms)，参数为事件名称。触发一次后移除该事件的耗时监听（上报的数据中会一个添加 costTime 字段）。

使用示例：

比如要监听用户从进入页面到点击购买按钮，花费了多少时间

smart.init('token-xxx');

// 首先添加监听点击购买按钮事件定时器
smart.time_event('buy');

// 当点击购买按钮后，上报的数据中会一个添加 costTime 字段（时间戳）
document.getElementsByTagName('h2')[0].onclick = function(e) {
  smart.track_event("buy",{"price":"￥123", "id": 'xxxx-xxxx-xxxx'});
}

6. debug

当想在调试器中打印出上报的数据，如下设置:

smart.init('xxx', {
  // 启动调试
  debug: true
});

7. 配置钩子函数

若想在sdk触发任意事件前，处理一些事情，那么可以配置一个钩子函数。

smart.init('xxx', {
  // 钩子函数
  loaded: function(sdk) {
    // 这里给每个事件都设置一个通用属性
    sdk.register_event_super_properties({test:'通用属性设置'});
  }
});

8. smart.register_event_super_properties(properties)

给每个事件设置通用属性（若想初始时每个内置事件都有效，请参考 配置钩子函数 示例）。

smart.init('xxx');
smart.register_event_super_properties({test:'通用属性设置'});

9. smart.clear_event_super_properties()

清除本地的通用属性

smart.init('xxx');
smart.clear_event_super_properties();

10. smart.login

登录时调用，上报的数据中会一个添加 userId 字段

smart.init('xxx');
smart.login('[email protected]');

11. 渠道推广

sdk通过判断url中的指定参数，来确定当前是否是渠道推广。渠道推广信息默认30天后过期。
当落地页是推广页时，sdk会自动上报 smart_ad_click 事件。

长链示例：

http://localhost:3300/example/index.html?utm_source=测试2&utm_medium=测试2&utm_campaign=测试&utm_content=&utm_term=&promotional_id=111

当落地页是短链跳转后的地址，sdk通过判断url是否带有t_re确定。

短链跳转后的落地页示例：

http://localhost:3300/example/index.html?utm_source=测试2&utm_medium=测试2&utm_campaign=测试&utm_content=&utm_term=&promotional_id=111&t_re=1

url推广页参数说明（广告地址）：

字段名称	类型	说明
utm_source	string	广告来源(必须字段)
utm_medium	string	广告媒介(必须字段)
utm_campaign	string	广告名称(必须字段)
promotional_id	string	广告id(必须字段)
utm_content	string	广告内容(选填)
utm_term	string	广告关键词(选填)

12. 上报用户事件通用属性说明

字段名称	类型	说明
browser	string	浏览器
browserVersion	string	浏览器版本
currentDomain	string	当前访问页面的域名
currentUrl	string	当前访问页面的url
title	string	当前访问页面的标题
urlPath	string	当前访问页面的路径
deviceId	string	本地唯一标记(可理解为设备id)
deviceOs	string	客户端操作系统
deviceOsVersion	string	客户端操作系统版本
devicePlatform	string	客户端平台（桌面、安卓、ios）
eventId	string	上报事件的id
dataType	string	事件类型（具体请看 src/config 中的 SYSTEM_EVENT_OBJECT）
language	string	本地客户端语言
pageOpenScene	string	网页打开场景（浏览器、APP）
persistedTime	string	用户首次访问网站时间戳
referrer	string	上一页url（来源页url）
referringDomain	string	上一页域名（来源页域名）
screenHeight	string	本地客户端屏幕高度（像素）
screenWidth	string	本地客户端屏幕宽度（像素）
sdkType	string	引入的sdk类型(网页：js)
sdkVersion	string	引入的sdk版本
sessionUuid	string	当前会话的id
time	string	当前上报事件用户触发的时间戳
token	string	上报数据凭证（通过它来归类数据）
promotionalID	string	渠道推广的广告id（本地若有数据的话）
utmCampaign	string	渠道推广的广告名称（本地若有数据的话）
utmMedium	string	渠道推广的广告媒介（本地若有数据的话）
utmSource	string	渠道推广的广告来源（本地若有数据的话）
utmContent	string	渠道推广的广告内容（本地若有数据的话）
utmTerm	string	渠道推广的广告关键词（本地若有数据的话）

进度说明

当前采集库支持到最基本的代码埋点，更多功能作者正在努力开发中。