埋点API

6.1 pageConfig

pageConfig为全局设置页面的页面编码的方式，具体示例如下：

const aplusConfig = {
  metaInfo: {
   'appKey': 'testappkey', //QuickTracking 创建应用时填写的Appkey, 必填
   'aplus-rhost-v': 'your_log_domain', //采集日志上报域名，必填
   '_user_id': 'testUserId',  //小程序自身的登录账号id，如需要计算分析用户账号纬度的数据，需上报
   '_anony_id': 'testOpenid', //小程序平台用户唯一标识，用于计算UV, 必填
   'DEBUG': true, //打开调试日志
   'appVersion': '您当前小程序的版本',

   //全局配置页面编码
   //若未设置页面编码默认为path
   //若未设置页面标题微信小程序默认为页面标题，其他小程序默认为""
   'pageConfig': {
      'pages/index/index': {
        'pageName': 'page_name_test_index', 
        'pageTitle': '首页',
        'skipMe': true //忽略自动上报该页面的页面浏览事件， 默认为undefined
      },
      'pages/detail/detail': {
        'pageName': 'page_name_test_detail',
        'pageTitle': '详情页'
      },
    }
  }
};

其中pageName表示页面编码，pageTitle表示页面标题，skipMe为是否关闭该页面的自动采集（true表示关闭，false表示开启；该设置的优先级高于关闭页面浏览事件自动采集的总开关aplus-disable-apv）。

aplus.aplus_queue.push({
  action: 'aplus.setMetaInfo',
  arguments: ['aplus-disable-apv', true]
});

Page({
  onShow() {
    getApp().aplus.aplus_queue.push({
      action: 'aplus.updatePageProperties',
      arguments: [$properties, $page_path]
    })
  }
});

Page({
  onShow() {
    getApp().aplus.aplus_queue.push({
      action: 'aplus.updatePageProperties',
      arguments: [{
        page_name: 'home_page',
        param1: 1,
        param2: 2,
      }, 'pages/index/index']
    })
  }
});

6.3 页面手动采集

接口

sendPV 方法将发送一条页面 PV 日志，其 API 定义如下：

aplus.aplus_queue.push({
 action: 'aplus.sendPV',
  arguments: [pageEventConfig, userData]
});

其中：

• pageEventConfig 为页面事件的配置，只需要写死{ is_auto: false } 即可

• userdata 为本次页面事件的扩展参数，其取值为一个 JSON 对象（平铺的简单对象，不能多层嵌套），若无可传空对象'{}'

示例：

// 一个简单的demo
aplus.aplus_queue.push({
  'action':'aplus.sendPV',
  'arguments':[{
    is_auto: false
  }, {
    
    page_title: "首页", //默认为pageConfig中的值，如果这里设置了，则为这里设置的值 (非必传)
    page_name: "yourCurrentPageName", //默认为pageConfig中的值，如果这里设置了，则为这里设置的值 (非必传)
    
    //自定义事件属性
    x: 111,
    y: 222
  }]
});

页面标题（page_title）默认为pageConfig中的值，如果这里设置了，则为这里设置的值；

页面编码（page_name）默认为pageConfig中的值，如果这里设置了，则为这里设置的值；

效果如：

7.1 曝光事件

EXP特指曝光事件

aplus.aplus_queue.push({
  'action':'aplus.record',
  'arguments':['埋点方案中的事件编码', 'EXP', {
    x: '111',
    y: '222',
    z: 333,
    page_name: "demoPageName", //您当前页面的自定义页面编码（非必传）
  }]
});

7.2 点击事件

CLK特指点击事件

aplus.aplus_queue.push({
  'action':'aplus.record',
  'arguments':['埋点方案中的事件编码', 'CLK', {
    x: '111',
    y: '222',
    z: 333,
    page_name: "demoPageName", //您当前页面的自定义页面编码（非必传）
  }]
});

7.3 OTHER 其他事件埋点

OTHER特指除点击和曝光事件外的其他自定义事件

aplus.aplus_queue.push({
  'action':'aplus.record',
  'arguments':['埋点方案中的事件编码', 'OTHER', {
    x: '111',
    y: '222',
    z: 333,
    page_name: "demoPageName", //您当前页面的自定义页面编码（非必传）
  }]
});

7.4 自动曝光（全埋点）

从aplus_mini.js@1.1.0开始，由SDK内部帮助开发者处理曝光时机，并自动采集元素曝光行为。触发时机为控件展示在可视区域内面积超过50%，时间超过300ms。

以微信为例， UI部分：

// 页面WXML文件根节点埋点capture-bind:touchstart：
<view capture-bind:touchstart="onAplusTouch">
  
// 待曝光节点添加class和data-tracker(对应app.js中自动点击的配置)，如:
<view class="button-section">
  <button 
     class="auto-exposure"
     data-pagename="自定义当前事件的页面编码" 
     data-page_title="自定义当前事件的页面标题" 
     data-name="btn-navigator" 
     data-index="num1"
     bindtap="onNavigatorTap">导航</button>
  <button 
     class="autotrack_exp" 
     data-itemName='读书' 
     data-itemzoon='abc' 
     data-itemid='a_product_id' 
     data-promotioninformation='abc' 
     data-pagename='首页'>autoExp</button>
</view>

SDK 配置部分：

var aplus = require('./utils/aplus_mini.js')({
  metaInfo: {
    'aplus-auto-exp': [{
      'cssSelector':'.auto-exposure', // 你要曝光的元素的class 
      'logkey':'auto-exp-id', // 埋点方案中对应的事件编码
      // 注意：
      // 1、如果CSSSelector能匹配上多个元素则一定要在页面节点上埋data-tracker,否则aplusJS无法识别元素唯一性，进而导致一个列表多个元素只能触发一次曝光；
      // 2、目前支付宝小程序不支持该属性采集
      'props': ['data-name', 'data-index', 'data-pagename', 'data-page_title']
    }, {
      'cssSelector':'.autotrack_exp', // 你要曝光的元素的class 
      'logkey':'autotrack_exp', // 埋点方案中对应的事件编码
    }],
//自动曝光的前置回调函数，用于支持定制化参数上报，如驼峰写法等（html数据属性默认只支持小写）
//1.9.25版本及以上支持
    'aplus-auto-exp-userfn': function(e, selector) {
      if (selector.indexOf('autotrack_exp') != -1) {
        var dataset = e.dataset;
        var obj = {};
        obj.itemID = dataset.itemid;
        obj.itemName = dataset.itemname;
        obj.itemZoon = dataset.itemzoon;
        obj.promotionInformation = dataset.promotioninformation;
        obj.pageName = dataset.pagename;          
        return obj;
      }
    }
  }
});

或开发者在某个时机，通过setMetaInfo 或 appendMetaInfo 更改自动曝光配置，之后的再触发元素时才会生效

aplus.aplus_queue.push({
	action: 'aplus.setMetaInfo',
  arguments: ['aplus-auto-exp', [{
      'cssSelector':'.auto-exposure',
      'logkey':'demoEventCode', //埋点方案中对应的事件编码
      'props': ['data-name', 'data-index', 'data-pagename', 'data-page_title'], // 埋点方案中的自定义属性
    }, {
      'cssSelector':'.autotrack_exp', // 你要曝光的元素的class 
      'logkey':'autotrack_exp', // 埋点方案中对应的事件编码
    }]
  ]
});

//或者

aplus.aplus_queue.push({
	action: 'aplus.appendMetaInfo',
  arguments: ['aplus-auto-exp', [{
      'cssSelector':'.auto-exposure',
      'logkey':'demoEventCode', //埋点方案中对应的事件编码
      'props': ['data-name', 'data-index', 'data-pagename', 'data-page_title'], // 埋点方案中的自定义属性
    }, {
      'cssSelector':'.autotrack_exp', // 你要曝光的元素的class 
      'logkey':'autotrack_exp', // 埋点方案中对应的事件编码
    }]
  ]
});

// 自动曝光事件的前置回调函数，用于支持定制化参数上报，如驼峰写法等（html数据属性默认只支持小写）
//1.9.25版本及以上支持
aplus.aplus_queue.push({
	action: 'aplus.setMetaInfo',
  arguments: ['aplus-auto-exp-userfn', function(e, selector) {
      if (selector.indexOf('autotrack_exp') != -1) {
        var dataset = e.dataset;
        var obj = {};
        obj.itemID = dataset.itemid;
        obj.itemName = dataset.itemname;
        obj.itemZoon = dataset.itemzoon;
        obj.promotionInformation = dataset.promotioninformation;
        obj.pageName = dataset.pagename;          
        return obj;
     }
  }]
});

自动曝光前置回调函数，默认值为undefined，如需开启，需设置：

aplus_queue.push({
action: 'aplus.setMetaInfo',
arguments: ['aplus-auto-exp-userfn', function(e， selector) { 
/**
  * e: DOM元素
  * selector: 元素的选择器，取值为自动点击中传入的cssSelector
  * @return 自定义属性对象
  */
       }]
 })

7.5 自动点击（全埋点）

从aplus_mini.js@1.1.0开始，为减少开发者埋点工作量，SDK也支持通过配置部分信息，让SDK自动采集页面内的点击事件。（支付宝、百度小程序需要基础库2.x版本以上才支持）

以微信为例， UI部分：

// 页面WXML文件根节点埋点catchtap：
<view catchtap="onAplusClk">
  
// 待曝光节点添加class和data-tracker(对应app.js中自动点击的配置)，如:
<view class="button-section">
  <button 
     class="auto-click" 
     data-pagename="自定义当前事件的页面编码" 
     data-page_title="自定义当前事件的页面标题" 
     bindtap="onNavigatorTap">导航</button>
  <button 
     class="autotrack_clk" 
     data-itemName='读书' 
     data-itemzoon='abc' 
     data-itemid='a_product_id' 
     data-promotioninformation='abc' 
     data-pagename='首页'>autoClk</button>
</view>

SDK 配置部分：

var aplus = require('./utils/aplus_mini.js')({
  metaInfo: {
    'aplus-auto-clk': [{
      'cssSelector':'.auto-click',
      'logkey':'demoEventCode', //埋点方案中对应的事件编码
      'props': ['data-name', 'data-pagename', 'data-page_title'], // 埋点方案中的自定义属性
    }, {
      'cssSelector':'.autotrack_clk',
      'logkey':'autotrack_clk', //埋点方案中对应的事件编码
    }],
    // 自动点击事件的前置回调函数，用于支持定制化参数上报，如驼峰写法等（html数据属性默认只支持小写）
    'aplus-auto-clk-userfn': function(e, selector) {
      if (selector.indexOf('autotrack_clk') != -1) {
        var dataset = e.dataset;
        var obj = {};
        obj.itemID = dataset.itemid;
        obj.itemName = dataset.itemname;
        obj.itemZoon = dataset.itemzoon;
        // obj.promotionInformation = dataset.promotioninformation;
        obj.pageName = dataset.pagename;          
        return obj;
      }
    },
  }
});

或开发者在某个时机，通过setMetaInfo 或 appendMetaInfo 更改自动点击配置，之后的再触发元素时才会生效

aplus.aplus_queue.push({
	action: 'aplus.setMetaInfo',
  arguments: ['aplus-auto-clk', [{
      'cssSelector':'.auto-click',
      'logkey':'demoEventCode', //埋点方案中对应的事件编码
      'props': ['data-name', 'data-pagename', 'data-page_title'], // 埋点方案中的自定义属性
    }, {
      'cssSelector':'.auto-click',
      'logkey':'demoEventCode', //埋点方案中对应的事件编码
    }]
  ]
});

//或者

aplus.aplus_queue.push({
	action: 'aplus.appendMetaInfo',
  arguments: ['aplus-auto-clk', [{
      'cssSelector':'.auto-click',
      'logkey':'demoEventCode', //埋点方案中对应的事件编码
      'props': ['data-name', 'data-pagename', 'data-page_title'], // 埋点方案中的自定义属性
    }]
  ]
});
// 自动点击事件的前置回调函数，用于支持定制化参数上报，如驼峰写法等（html数据属性默认只支持小写）
aplus.aplus_queue.push({
	action: 'aplus.setMetaInfo',
  arguments: ['aplus-auto-clk-userfn', function(e, selector) {
      if (selector.indexOf('autotrack_clk') != -1) {
        var dataset = e.dataset;
        var obj = {};
        obj.itemID = dataset.itemid;
        obj.itemName = dataset.itemname;
        obj.itemZoon = dataset.itemzoon;
        // obj.promotionInformation = dataset.promotioninformation;
        obj.pageName = dataset.pagename;          
        return obj;
     }
  }]
});