神策分析 JavaScript SDK 点击图(网页热力分析) 使用说明

最后更新于：2018-08-24 14:01:37

1 点击图

1 点击图依赖全埋点采集的两个预置事件：$PageView, $WebClick。并且元数据管理里面，这两个事件不能隐藏。
这两个预置事件的采集，参考全埋点(AutoTrack)

2 点击图的展现，需要至少 3 个触发用户数才能展现。

3 使用点击图需要开启我们 sdk 提供的默认页面浏览事件即 sa.quick('autoTrack'); 因为点击率这个参数的计算是需要 PV 这个数据的，如果不调用这个方法可能会出现点击率(?): Infinity% 这种情况。

我们建议那些按钮不是很多的，相对简单的页面可以采用这个方法。一般情况下，如果网页上的按钮比较多的话，因为每次按钮的点击都会发数据，会导数据量增大，可能会加磁盘。

2 触达图

1 触达图依赖全埋点采集的预置事件：$WebStay 的数据采集，并且元数据管理里面，这个事件不能隐藏。

3 点击图详细配置参数

必填参数：

web_url: 神策分析后台地址，代码生成工具会自动生成。如果神策后台版本是 1.10 及以上版本，这个参数不需要配置。
heatmap_url:（1.9以上版本新加） heatmap.min.js 文件的地址，在热力分析渲染页面时会用到。
heatmap: 必须配置这个参数才会发送数据，如果只想采集所有页面的仅交互按钮的数据，可以使用这种配置方式 heatmap:{} 。具体参数配置如下:

heatmap: {
    //是否开启点击图，默认 default 表示开启，可以设置 'not_collect' 表示关闭
    //需要 JSSDK 版本号大于 1.7
    clickmap:'default',
    //是否开启触达注意力图，默认 default 表示开启，可以设置 'not_collect' 表示关闭
    //需要 JSSDK 版本号大于 1.9.1
    scroll_notice_map:'default',
    //设置成 true 后，我们会自动给 a 标签绑定一个 sa.trackLink() 方法（详见本页 3.3 ）。
    //如果是单页面 a 标签不涉及页面跳转或者 a 标签的点击是下载功能，建议不要打开。默认 false 。
    isTrackLink: false,
    //设置多少毫秒后开始渲染点击图,因为刚打开页面时候页面有些元素还没加载
    loadTimeout:  3000,
    //返回真会采集当前页面的数据，返回假表示不采集当前页面,设置这个函数后，内容为空的话，是返回假的。不设置函数默认是采集所有页面
    collect_url: function(){
        //如果只采集首页
        if(location.href === 'xxx.com/index.html' || location.href === 'xxx.com/'){
            return true;
        }
    },
    //用户点击（a，button，input）这些元素时会触发这个函数，让你来判断是否要采集当前这个元素，返回真表示采集，返回假表示不采集。
    //不设置这个函数，默认是采集 a button input 这些标签。
    collect_element: function(element_target){
        // 如果这个元素有属性sensors-disable=true时候，不采集
        if(element_target.getAttribute('sensors-disable') === 'true'){
            return false;
        }else{
            return true;
        }
    },
    //考虑到用户隐私，这里可以设置input里的内容是否采集
    //如果返回真，表示采集input内容，返回假表示不采集input内容,默认不采集    
    collect_input:function(element_target){
        //例如如果元素的id是a，就采集这个元素里的内容
        if(element_target.id === 'a'){
            return true;
        }
    },
    //假如要在 $WebClick 事件增加自定义属性，可以通过（a，button，input）这三类标签的特征来判断是否要增加
    custom_property:function( element_target ){
        //比如您需要给有 data=test 属性的标签的点击事件增加自定义属性 name:'aa' ，则代码如下
        if(element_target.getAttribute('data') === 'test'){
            return {
                name:'aa'
            } 
        }          
    },
    // 设置触达图的有效停留时间，默认超过4秒以上算有效停留
    scroll_delay_time: 4000
}

点击图默认只采集这些交互元素（ a input button ），如果你想要对其他元素采集的话，请在元素发生点击的时候，调用我们的这个方法。

// 下面演示点击图片的时候也触发点击图事件
$('img').on('click',function(){
    sa.quick('trackHeatMap',this); //第二个参数是发生事件的dom元素
});