打点SDK

• Features
• Installing
• Usage
• API
• License

Features

页面打点信息采集

Installing

NPM

$ npm i monitor-game --save

SCRIPT

  <script type="text/javascript" src="https://unpkg.com/monitor-game/dist/monitor-game.min.js"></script>

Usage

1. sdk在全局下的变量名是MonitorGame。
2. 设置打点信息发送到的服务地址configUrl(object)。
3. 设置打点时传送的基础参数数据setBaseLogData(Function | Object),参数值可为对象或函数，如果为函数，则基础参数为函数的返回值`。
4. 设置打点指标在html标签中的属性名setMetricAttributeName('data-wk') // 可选，不设置时默认值为'data-wk'。
5. 设置打点指标在发送给服务端时的参数名setMetricParamName('event_key') // 可选，默认值为'metric'。
6. 监听点击事件，并统计打点信息getClickAndKeydown。

Example

  MonitorGame
    .configUrl({
      click: 'serviceUrl'
    })
    .setBaseLogData(function() {
      return {
        param1: 'param1',
        param2: 'param2',
        param3: 'param3',
        time_str: MonitorGame.getCurrentTime()
      }
    })
    .setMetricParamName('event_key')  // 可选，默认值为“metric”
    .setMetricAttributeName('data-wk') // 可选，默认值为“data-wk”
    .getClickAndKeydown();

API

设置打点发送到的服务端url

  MonitorGame.configUrl({
    click: 'clickUrl',
    clickHeatMap: 'clickHeatMapUrl'
  });

设置发送打点信息时传递给服务端的基础参数

  // 参数可为对象或函数，如果为函数，则附加的基础参数为函数的返回值

  MonitorGame
    .setBaseLogData(function() {
      return {
        param1: 'param1',
        param2: 'param2',
        param3: 'param3',
        time_str: MonitorGame.getCurrentTime()
      }
    })

  // or

  MonitorGame
    .setBaseLogData({
      param1: 'param1',
      param2: 'param2',
      param3: 'param3',
    })

设置打点指标在发送给服务端时的参数名

  MonitorGame.setMetricParamName('event_key');

设置打点指标在html标签中的属性名

  MonitorGame.setMetricAttributeName('data-wk')

监听点击事件进行打点

  MonitorGame.getClickAndKeydown();

热力图打点

  MonitorGame.getClickHeatmap();

手动发送打点（可选）

  MonitorGame.send({event_key: 'test'});

License

MIT