Skip to content

Commit 66c01d3

Browse files
author
Fu Lili
committed
重写 README
1 parent d6e9958 commit 66c01d3

File tree

1 file changed

+17
-53
lines changed

1 file changed

+17
-53
lines changed

README.md

Lines changed: 17 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,22 @@
11
# sa-sdk-javascript
22

3-
Sensors Analytics JavaScript SDK
4-
5-
# 代码埋点和可视化埋点介绍
6-
7-
代码埋点参考 http://www.sensorsdata.cn/manual/js_sdk.html
8-
代码埋点只需要把 sdk_url 设置成 sensorsdata.min.js
9-
10-
可视化埋点参考 https://sensorsdata.cn/manual/vtrack_intro.html
11-
可视化埋点只需要把 sdk_url 设置成 vtrack.min.js 同时同级目录下必须包含这两个文件 vendor.min.js vendor.min.css
12-
可视化埋点代码里包含了代码埋点的所有功能,所以使用可视化埋点的话,也可以使用代码埋点的功能。
13-
***注意*** 能用代码埋点就用代码埋点,尽量不要用可视化埋点!具体原因参考可视化埋点文档。
14-
15-
如有疑问请联系邮箱 [email protected] 比较着急的话可以QQ522370351
16-
17-
# 代码埋点最佳实践
18-
1. 控制台: 在代码埋点时,在控制台会打出 console 。每次 track 都会打出一个对象,里面 event 是你设置的事件名,注意观察数据是否和自己想要的一致!如果没出现,就是埋点失败!同时注意观察控制台的报错,会提示各种错误信息,比如事件名不合法,或者属性值无效等!
19-
2. 左下角的埋点管理: 这里会汇总数据的错误。
20-
3. 后端验证: 设置 debug_mode:true。这里除了会打 console 外,还会发一次 ajax 请求,在后端会再次验证数据是否合法。
21-
22-
# 使用说明
23-
1. /product下的是 代码埋点的最新源文件,欢迎提交修改。可视化埋点较为复杂,没有提供源文件,且不推荐使用。
24-
2. /dist下的是 可视化埋点和代码埋点的可用发行版文件。请将 /dist/版本号 下的文件都下载到你们自己网站目录下面!!!
25-
4. ***升级使用新版 SDK 前,请在微信群里先问下你们的神策分析系统版本是否支持!!!***
26-
27-
####1.5.8(注意1.5.4的要求要更新到1.5最新系统)
28-
修复了首次profile不能导入的bug
29-
####1.5.7(注意1.5.4的要求要更新到1.5最新系统)
30-
因为某些server配置只能接收7K内的url。所以给字符串类型加上长度限制,默认最长1k。$pageview中默认取的referrer最大默认取800。可以在配置中设置 max_string_length: 1000 来修改最大限制长度。
31-
####1.5.6(注意1.5.4的要求要更新到1.5最新系统)
32-
给每个请求加上nocache的参数,防止ie11等浏览器缓存
33-
####1.5.5(注意1.5.4的要求要更新到1.5最新系统)
34-
兼容重复引用sdk导致的distinct_id是null等多种异常问题,修复在埋点管理里没有显示埋点类型的问题,修复registerOnce的bug。
35-
####1.5.4(注意此次修改要同步更新到1.5最新神策系统,未更新会导致数据丢失!!!)
36-
增加自定义来源渠道参数source_channel,自定义渠道的参数也会被加到$pageview中,增加$is_first_time,增加异常检测(distinct_id为null的问题),$is_first_day如果为假时候,也会传属性false。把$pageview的$browser_language属性改成用户属性。
37-
#####1.5.3
38-
可视化埋点定义模式下修复找不到元素时控制台报错的问题,修复定义模式下iframe非本域时加载脚本时控制台报错的问题。
39-
#####1.5.2
40-
可视化埋点增加选择器过滤功能
41-
#####1.5.1
42-
修复如果后端地址是 sa.xx 开头时候,发送地址替换gif错误的问题。增加web_url应对客户自定义后端api地址的问题。修复页面iframe了非同源页面后的bug。
43-
#####1.5
44-
支持神策分析系统1.5版本多project,全埋点管理查看,以及把$pageview中的utm相关参数改成了$utm,
45-
#####1.4.5
46-
增加callback,比如在数据发送成功后再跳转页面,sa.track('event',{},function(){location.href="..."})。
47-
#####1.4.4
48-
可视化埋点支持iframe,代码埋点的$screen_height,$screen_width强制转换成数值类型,某些手机奇葩浏览器对这两个值取值异常。
49-
#####1.4.3
50-
增加sa.quick('autoTrack')方法,可以自动追踪pv,增加是否是首日访问等预置属性,和设置首次来源,首次时间等。
51-
同时对于属性的验证放宽,如果属性名错误,一样会发到后端。之前是会在前端抛掉。目前这样做可以方便在后端看到错误,方便debug错误原因。
52-
#####1.4.2 (2016-6-15 注意此次修改要同步更新神策系统,未更新会导致数据丢失!!!)
53-
使用服务器端时间
54-
#####1.4.1 (稳定版)
55-
把$os 改成 iPhone OS 和 Android 为了跟安卓iphone兼容
3+
Sensors Analytics JavaScript SDK
4+
5+
完整文档请[点击这里](http://www.sensorsdata.cn/manual/js_sdk.html),如有疑问请联系邮箱 [email protected],比较着急的话可以QQ:522370351。
6+
7+
## 获取发行版
8+
9+
> 注意 SDK 可能不完全向前兼容,请阅读具体的 Release Log。如果不确定是否支持,请联系神策技术支持人员。
10+
11+
请根据需要 [Releases](https://github.com/sensorsdata/sa-sdk-javascript/releases) 里下载对应的文件:
12+
13+
* sensorsdata.min.js:代码埋点的主文件,如果用可视化埋点不需要。
14+
* vtrack.min.js:可视化埋点的主文件,启用可视化埋点需要。
15+
* vendor.min.css:可视化埋点配置界面的样式文件。
16+
* vendor.min.js:可视化埋点配置界面的代码文件。
17+
18+
可视化埋点代码里包含了代码埋点的所有功能,所以使用可视化埋点的话,也可以使用代码埋点的功能。建议代码埋点为主,可视化埋点为辅。
19+
5620

5721

5822

0 commit comments

Comments
 (0)