sensor-demo v1.1.5

sensor 上报

介绍

探针，以下文档对照钉钉中探针上报表格得出，因为文档很少维护，可能在使用过程中会出现问题，希望在使用测试时完善此文档

使用

yarn add sensor-demo #OR <script src='资源地址'></script>

yarn build # 打包

yarn dev # 热更新

在原生中使用，引入js文件

1. 如果系统中新引入的神策，先统一执行注册 demo

   $tracker.init({
      initSensorParams: {
        userId: 'gy003',
        model_type: '',
        mac: '',
        registerPageParams: {
          current_url: location.href,
          referrer: document.referrer
        }
      }
    })

！！！我们也可以在init中预设一些参数

   $tracker.init({
      defaultFetchDomain: 'xxxx', // 默认上报地址domain    !!!! 必填
      STBFetchDomain: 'xxxx', // STB 上报Domain   !!! 必填
      enUrl: 'http://10.5.2.17:82/lt/en/', // 热力图地址 !!! 必填
      getReferPageName: () => '哈哈哈', // 如果这里不需要定义，那在上报时需要手动填写ReferPageName参数
      getReferPageUrl: () => 'http://',// 如果这里不需要定义，那在上报时需要手动填写ReferPageUrl参数
      trace_id: 'sssss',  // 需要保存到上下文的参数
      // 注册，登录，如果项目中已经有神策，不需要传此参数
      initSensorParams: {
        userId: 'gy003',
        model_type: '',
        mac: '',
        registerPageParams: {
          current_url: location.href,
          referrer: document.referrer
        }
      }
    })

2. 再上报

// 先引入文件
<script src=''></script>
// 直接使用Tracker
<script type="javascript/text">
  $tracker.reportTrackerLogger(type, xxxxxx)
</script>

在esmodule中使用

  import tracker from 'xxx'
  tracker.reportTrackerLogger(type, xxxxxx)

参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request

API

• reportTrackerLogger 上报
• registerHandle() 注册探针
• setParams({}) 保存参数

上报事件

ViewColumn 浏览栏目页

API reportTrackerLogger

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('ViewColumn',{
        ReferPageName: 'Hi I am a demo',
        PageUrl: 'http://localhost:8080',
        ClickRecommend: 'http: //localhost: 30001',
        ReferPageType: '推荐',
        ReferPosition: '首页 第3屏 左2',
        ColumnPosition: 30,
        $item_join: ['recommend#2121212']
      })

ViewDetail 浏览详情页

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('ViewDetail',{
        ReferPageName: 'Hi I am a demo',
        PageUrl: 'http://localhost:8080',
        ClickRecommend: 'http: //localhost: 30001',
        ReferPageType: '推荐',
        ReferPosition: '首页 第3屏 左2',
        ColumnPosition: 30,
        $item_join: ['recommend#2121212'],
        ...
      })

ViewSubject 浏览专题页

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('ViewSubject',{
        ReferPageName: 'Hi I am a demo',
        PageUrl: 'http://localhost:8080',
        ClickRecommend: 'http: //localhost: 30001',
        ReferPageType: '推荐',
        ReferPosition: '首页 第3屏 左2',
        ColumnPosition: 30,
        $item_join: ['recommend#2121212'],
        ...
      })

ViewFunction 浏览功能页

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('ViewFunction',{
        ReferPageName: 'Hi I am a demo',
        PageUrl: 'http://localhost:8080',
        ClickRecommend: 'http: //localhost: 30001',
        ReferPageType: '推荐',
        ReferPosition: '首页 第3屏 左2',
        ColumnPosition: 30,
        $item_join: ['recommend#2121212'],
        ...
      })

ViewProductList 浏览订购列表

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('ViewProductList',{
        ReferPageName: 'Hi I am a demo',
        PageUrl: 'http://localhost:8080',
        ClickRecommend: 'http: //localhost: 30001',
        ReferPageType: '推荐',
        ReferPosition: '首页 第3屏 左2',
        ColumnPosition: 30,
        $item_join: ['recommend#2121212'],
        ...
      })

ViewProductPay 浏览订购支付

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('ViewProductPay',{
        ReferPageName: 'Hi I am a demo',
        PageUrl: 'http://localhost:8080',
        ClickRecommend: 'http: //localhost: 30001',
        ReferPageType: '推荐',
        ReferPosition: '首页 第3屏 左2',
        ColumnPosition: 30,
        $item_join: ['recommend#2121212'],
        ...
      })

ErrorShow 报错提示

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('ErrorShow',{
        ErrorCode: 'Hi I am a demo',
        ErrorWord: 'http: //localhost: 30001',
        ErrorReason: '推荐',
        ReferPosition: '首页 第3屏 左2',
      })

ClickCollection 点击收藏

demo

import $tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('ClickCollection',{
        ContentID: 'xxxxxx',
        PageUrl: 'http://localhost:8080',
        ContentType: 'http: //localhost: 30001',
        ReferPosition: '首页 第3屏 左2',
        ChannelCode: '30',
        $item_join: ['recommend#2121212'],
      })

SearchResultNull 搜索结果为空

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('SearchResultNull',{
        KeyWord: 'Hi I am a demo',
        PageUrl: 'http://localhost:8080',
        ...
      })

ClickSearchResult 点击搜索结果

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('ClickSearchResult',{
        strategy_id: '30001',
        scene_id: '21212',
        SectionID: '2121',
        api_id: '30',
        $item_join: ['xxxx#2121212'],
        ...
      })

ClickFilterWord 点击筛选词

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('ClickFilterWord',{
        strategy_id: '30001',
        scene_id: '21212',
        SectionID: '2121',
        api_id: '30',
        $item_join: ['xxxx#2121212'],
        ...
      })

ClickFilterResult 点击筛选结果

demo

import $tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('ClickFilterResult',{
        strategy_id: '30001',
        scene_id: '21212',
        SectionID: '2121',
        api_id: '30',
        $item_join: ['xxxx#2121212'],
        ...
      })

ClickRecommend 推荐位点击

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('ClickRecommend',{
        strategy_id: '30001',
        scene_id: '21212',
        SectionID: '2121',
        api_id: '30',
        $item_join: ['xxxx#2121212'],
        ...
      })

TryPlay 试看

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('TryPlay',{
        strategy_id: '30001',
        scene_id: '21212',
        SectionID: '2121',
        api_id: '30',
        $item_join: ['xxxx#2121212'],
        ...
      })

PlayBackType 回看（包含老探针）

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('ClickRecommend',{
        strategy_id: '30001',
        scene_id: '21212',
        SectionID: '2121',
        api_id: '30',
        $item_join: ['xxxx#2121212'],
        bs: {
          ...
        }
        ...
      })

VodPlay 点播观看 （包含老探针）

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('VodPlay',{
        strategy_id: '30001',
        scene_id: '21212',
        SectionID: '2121',
        api_id: '30',
        $item_join: ['xxxx#2121212'],
        bs: {
          ...
        }
        ...
      })

TimeShiftPlay 时移

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('TimeShiftPlay',{
        strategy_id: '30001',
        scene_id: '21212',
        SectionID: '2121',
        api_id: '30',
        $item_join: ['xxxx#2121212'],
        ...
      })

ClickSubscribe 点击订购

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('ClickRecommend',{
        strategy_id: '30001',
        scene_id: '21212',
        SectionID: '2121',
        api_id: '30',
        $item_join: ['xxxx#2121212'],
        ...
      })

VideoPause 暂停播放

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('VideoPause',{
        strategy_id: '30001',
        scene_id: '21212',
        SectionID: '2121',
        api_id: '30',
        $item_join: ['xxxx#2121212'],
        ...
      })

bootStrapUser 开机上报（老版）

bs 参数，以下只是部分参数参考，具体还请根据钉钉中文档来做增减

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('bootStrapUser',{
       uid: 'ddd',
       sid: 'xxx',
       bs: {
        ....
       }
      })

uo 心跳（老版）

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('uo',{
       uid: 'ddd',
       sid: 'xxx',
       bs: {
        ....
       }
      })

bd pv/uv（老版）

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('bd',{
       uid: 'ddd',
       sid: 'xxx',
       ...
       bs: {
        ....
       }
      })

live 直播（老版）

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('live',{
       uid: 'ddd',
       sid: 'xxx',
       ...
       bs: {
        ....
       }
      })

vodScore 评分（老版）

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('vodScore',{
       uid: 'ddd',
       sid: 'xxx',
       ...
       bs: {
        ....
       }
    })

Activation 活跃（老版）

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('Activation',{
       uid: 'ddd',
       sid: 'xxx',
       ...
       bs: {
        ....
       }
    })

autoTrack 预置热力图

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
// 无须参数
 $tracker.reportTrackerLogger('autoTrack')

trackAllHeatMap 热力图采集

demo

import tracker from 'xxx'
// 或者
<script src="./xxxx.js"></script>
 $tracker.reportTrackerLogger('trackAllHeatMap', element)