埋点API_全域采集与增长分析-阿里云帮助中心

根据埋点方案，选择正确的埋点API。

1 如何查看埋点方案

在进行埋点前，需要确定在哪里埋点、埋哪些点等，即需要梳理清楚明确的埋点需求。在QuickTracking平台中将明确的埋点需求称为埋点方案，并为埋点方案设计了规范模板。如下：

在埋点方案中，明确的所需埋点内容有：

1、事件主体：指“谁”触发了这个事件，分为设备ID和账号ID，上报的事件务必具备其中之一。

设备ID：在H5中一般为QT自动生成，若H5页面嵌入在小程序中，则设备ID需要设置为小程序的设备ID。
账号ID：客户端用户登录后账号标识，当一个用户在不同的设备进行登录时，设备ID会发生变化，但是账号ID不会发生变化。例如一个用户使用手机和pad分别登录。

2、用户属性：针对账号ID的属性，例如账号ID为“testdemo@111”的用户，“生日”为“1999-02-13”，“会员等级”为“铂金”等。“生日”和“会员”等级就为用户属性。

3、渠道属性：广告投放的属性，例如投放渠道、投放方式、投放内容等。

4、全局属性：在全局设置一次后，每一个事件都会携带的属性

5、页面浏览事件：页面加载时上报的事件（埋点方案中页面编码和事件编码相等的事件，也是标记为蓝色的事件）

6、点击、曝光、自定义事件：客户端用户与客户端发生任意交互时上报的事件。

2 设置设备ID&账号ID

2.1 设备ID设置

Web设备ID有Quicktracking自动生成和开发者手动上传两种方式，默认为Quicktracking自动生成：

自动生成：默认逻辑，网站的设备ID只有浏览器发生变化或用户主动清除cookie和缓存时，设备ID会发生改变。
手动上传：上传方式为赋值给"_dev_id"，上传的度要在24-36字符。

//如采集用户ID是异步行为，需要先阻止SDK上报，设置BLOCK埋点
aplus_queue.push({
 action: 'aplus.setMetaInfo',
  arguments: ['_hold', 'BLOCK'] 
});

// 设置 _dev_id 
aplus_queue.push({
 action: "aplus.setMetaInfo",
  arguments: ["_dev_id", "自定义设备ID"]
});

 // 因为采集用户ID是异步行为，故需要先设置BLOCK，再设置START
 // 设置_hold=START后，事先被block住的日志会携带上用户信息逐条发出
aplus_queue.push({
 action: 'aplus.setMetaInfo',
  arguments: ['_hold', 'START'] 
});

2.2 账号ID设置

在用户登录时，以及登录态进入H5时，都需要设置账号ID。因为设置后的每一条日志都将携带账号ID，但退出H5再进入后触发的事件不会携带账号ID。所以需要在用户登录时，以及登录态进入H5时设置账号ID。

//用户登录时，获取到用户登录账号信息 or 用户已登录，通过cookie或者localstorage获取用户登录账号
function demoLogin() {
  /*************************如果同步场景***********************************/
  aplus_queue.push({
    action: 'aplus.setMetaInfo',
    arguments: ["_user_id", '用户的账号id']
  });
  
  /******************如果是异步场景,并且日志必须依赖用户账号***********************/
  //先通过设置_hold=BLOCK阻塞采集上报
  aplus_queue.push({
    action: 'aplus.setMetaInfo',
    arguments: ["_hold", 'BLOCK']
  });
  ...
  function callback() {
    //获取异步回调结果中的用户账号id
   aplus_queue.push({
      action: 'aplus.setMetaInfo',
      arguments: ["_user_id", '用户的账号id']
    });
    //再通过设置_hold=START允许采集上报
    aplus_queue.push({
      action: 'aplus.setMetaInfo',
      arguments: ["_hold", 'START']
    });
  };
  ...
};
//用户登出时，重置用户账号id
function demoLogOff() {
 aplus_queue.push({
    action: 'aplus.setMetaInfo',
    arguments: ["_user_id", ""]
  });
};

2.3 设备ID和账号ID获取

设备ID的获取

SDK自动生成的设备ID获取方式如下：

在当前域名的cookie下存储名为cna的字段，可以通过解析document.cookie获取

通过_dev_id方式自定义上传的设备ID获取方式如下：

开发者通过setMetaInfo设置_dev_id可以自定义设备ID，可通过aplus.getMetaInfo('_dev_id')读取

账号id的获取

开发者通过setMetaInfo设置_user_id可以自定义用户账号id，可通过aplus.getMetaInfo('_user_id')获取

3 设置用户属性

通过预制事件编码 $$_user_profile 上报用户属性，事件类型为其他事件。

在上报用户属性之前，需要先设置_user_id上报用户账号，否则QuickTracking流量分析对用户属性不会进行关联计算。确认上报用户的账号ID后，上报用户属性示例如下：

//示例
aplus_queue.push({
  'action':'aplus.record',
  'arguments':['$$_user_profile', 'OTHER', {
    name: 'sss',      //用户属性1
    gender: 'male',   //用户属性2     
    class: '3',       //用户属性3
  }]
});

上述内容中，2、3、4、8、9行不能发生任何变化，仅可自定义5、6、7行。

4 渠道属性

H5渠道参数场景分别为：

4.1 H5链接唤起App、小程序和H5页面

渠道属性无需进行任何埋点，但是需要唤起小程序或App的URL中携带这些渠道属性，且属性key务必以“utm_”开头，因为SDK识别的关键字为“utm_”。例如：

qaplus/product?utm_channel=gzh

PS：如果渠道属性已经与市面上渠道投放公司进行了合作，无法使用utm_开头，可以使用全局属性API将渠道属性进行埋点上报（属性key依然需要以“utm_”开头）。

4.2 H5链接唤起应用市场下载并启动App

该场景下，如果仅是H5链接中携带“utm_”参数，已经无法做到下载App后的启动事件携带“utm_”参数。所以需要进行“H5唤起事件”与“App启动事件”做关于“IP地址和浏览器UserAgent”的模糊匹配。

当H5唤起App时，上报“应用唤起事件（$$_app_link）”，在事件中需要携带唤起App的appkey

//示例
aplus_queue.push({
  action:'aplus.recordAppLink',
  arguments:[{
    targetAppKey: '要唤起的应用appKey',  // 必填，要唤起的应用appKey
    custom1: 'custom1', // 选填，自定义参数
    ...
  }]
})

App下载后的第一次启动事件“应用激活事件（$$_app_install）”由QT App SDK自动采集上报。
QT系统进行应用唤起事件（$$_app_link）和应用激活事件（$$_app_install）关于“IP地址和浏览器UserAgent”的模糊匹配。您使用时，可以直接在app应用中分析“应用激活（预置）”的渠道属性即可。

5 全局属性

全局属性的生命周期为首次设置全局属性API开始，到浏览器tab页面关闭、或者浏览器关闭、或者多页应用浏览器URL发生变化。

5.1 设置追加全局属性（aplus.appendMetaInfo）

使用aplus.appendMetaInfo进行全局属性上报时，如果和已经存在的全局属性key重复，则更新已有值；如果和已经存在的全局属性key不一致，则插入新的全局属性。

接口：

aplus_queue.push({
    action: 'aplus.appendMetaInfo',  //追加全局属性
    arguments: ['globalproperty', {
    		xxx: xxx,
    }]
});

示例：

aplus_queue.push({
    action: 'aplus.appendMetaInfo',  //追加全局属性
    arguments: ['globalproperty', {
    		a: 3, 
        b: 4
    }]
});
//当前globalproperty为a:3和b:4

aplus_queue.push({
    action: 'aplus.appendMetaInfo',  //追加全局属性
    arguments: ['globalproperty', {
    		b: 2, 
        d: 4
    }]
});
//当前globalproperty为a:3、b:2和d:4

全局属性设置后，将跟随之后触发的每一条事件日志上报。生命周期仅为API调用开始到H5页面关闭。

5.2 设置覆盖全局属性（aplus.setMetaInfo）

使用aplus.setMetaInfo进行全局属性上报时，仅会以最后一次上报为准。即先清空已有全部全局属性，再将本次setMetaInfo()设置的全局属性放入。

警告

请确认该方式符合业务逻辑再使用，常见使用场景为「清空」全局属性，请慎用该方式。

注意，使用该方法也会覆盖掉渠道属性！！！

接口：

aplus_queue.push({
    action: 'aplus.setMetaInfo',   //覆盖全局属性
    arguments: ['globalproperty', {
    		xxx: xxx
    }]
});

示例：

aplus_queue.push({
    action: 'aplus.setMetaInfo',
    arguments: ['globalproperty', {
       a: 1, 
       b: 2
    }]
});
//当前globalproperty为a:1和b:2

aplus_queue.push({
    action: 'aplus.setMetaInfo',
    arguments: ['globalproperty', {
       c: 1, 
       d: 2
    }]
});
//当前globalproperty为c:1和d:2,“a:1和b:2不再存在”

6 页面浏览事件API

1、页面浏览事件分为SDK自动埋点（全埋点）和代码埋点两种方式，默认页面浏览事件的全埋点是开启的。

2、页面浏览事件需要埋点的内容为：

事件编码：也就是页面编码，在页面浏览事件中事件编码即为页面编码。

页面浏览事件的事件属性：具体属性见埋点方案

6.1 pageConfig

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

<head>
...
  <script>
 
    ... sdk集成代码部分

    //设置页面编码 和 页面标题
    //如果是单页应用，设置pageConfig 【SDK v1.7.7以上】生效
    //若未设置pageConfig
    //页面编码默认为当前页面url，不带参数
    //页面标题默认为document.title
    aplus_queue.push({
      action: 'aplus.setMetaInfo',
      arguments: ['pageConfig', {
        hashMode: false, //默认为false 为History模式；开启哈希模式为true
        '/': {
          pageName: 'home_page_test',
          pageTitle: '首页',
          skipMe: true //忽略自动上报该页面的页面浏览事件， 默认为undefined
        },
        '/search': {    //基于location.pathname匹配
          pageName: 'search_page_test',
          pageTitle: '搜索页'
          regRule: /\/search/  //（可选校验动态路由
        },
        '#/hash_page': {  //基于location.hash匹配
          pageName: 'hash_page_test',
          pageTitle: 'hash模式页面'
          regRule: 一段能匹配当前hash路由的正则表达式 //（可选）校验动态路由
        }
      }]
    });
  //如果是多页应用，设置aplus-pagename 【SDK v1.8.1以上】生效
  aplus_queue.push({
      action: 'aplus.setMetaInfo',
      arguments: ['aplus-pagename', "test_pagename"]
    });
 /**********************************分割线********************************/
  </script>
</head>

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

6.2 页面自动埋点（全埋点）

SDK识别到页面中SDK的代码加载完成时，上报页面浏览事件，上报的内容为：

当前客户端时间
页面path
页面编码（默认为页面path，如果设置了pageconfig，则取值为映射的page_name）
页面标题（默认为页面title，如果设置了pageconfig，则取值为映射的page_title）
页面停留时长：SDK不采集！
SDK自动上报的页面浏览事件，不支持设置事件属性

页面自动上报默认是开启的，如果需要关闭自动页面上报，API如下：

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

如果仅须关闭某一页面的自动页面上报，可以在pageconfig中调用skipMe为true关闭。

6.3 页面手动采集

接口

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

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

其中

pageEventConfig 为页面事件的配置，只需要写死{ is_auto: false } 即可
userdata 为本次页面事件的扩展参数，其取值为一个 JSON 对象（平铺的简单对象，不能多层嵌套），若无可传空对象'{}'

示例：

// 一个简单的demo
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 事件埋点

除了页面浏览事件外的事件都使用'action':'aplus.record'进行埋点，事件需要埋点的内容有：

事件编码：

事件属性：

页面编码（可选）：SDK默认采集页面path，如果页面path在pageConfig中进行了映射，并设置了page_name，则取值为pageConfig中的page_name。如果在事件埋点时，在事件属性中设置了page_name，则取值为事件属性中的page_name。也就是取值优先级为

事件属性中的page_name > pageConfig中的page_name > 页面path

页面标题（可选）：SDK默认采集页面title，如果页面path在pageConfig中进行了映射，并设置了page_title，则取值为pageConfig中的page_title。如果在事件埋点时，在事件属性中设置了page_title，则取值为事件属性中的page_title。也就是取值优先级为

事件属性中的page_title > pageConfig中的page_title > 页面title

事件埋点分为SDK自动埋点（全埋点）和代码埋点两种方式，默认点击和曝光的全埋点是关闭的。

7.1 曝光事件

EXP特指曝光事件

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

7.2 点击事件

CLK特指点击事件

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

7.3 OTHER 其他事件埋点

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

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

7.4 自动曝光（全埋点）

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

<body>
  <div id="root">
    <h1 class="title">demo</h1>
    <!-- 如果需要传递参数，通过html的数据属性传递 data-*的方式,请使用小写字母组合定义参数 -->
    <button class="autoexp-component-css" 
            data-pagename="自定义当前事件的页面编码"
            data-page_title="自定义当前事件的页面标题">测试曝光</button>
    <List>
     <List.Item class="autoexp-list-item" data-name={"a"}>a</List.Item>
      <List.Item class="autoexp-list-item" data-name={"b"}>b</List.Item>
      <List.Item class="autoexp-list-item" data-name={"c"}>c</List.Item>
      <List.Item 
            class='autotrack_exp_web' 
            data-itemname={'读书'} 
            data-itemzoon={'abc'} 
            data-itemid={'a_product_id'} 
            data-promotioninformation={'abc'} 
            data-pagename={'首页'}>全埋点-自动曝光</List.Item>

    </List>
  </div>
</body>

sdk 配置部分：

aplus_queue.push({
  action: 'aplus.setMetaInfo',
  arguments: ['aplus-auto-exp',[
     //采集button元素的曝光行为
      {
          cssSelector: '.autoexp-component-css', // 你要曝光的元素class 
          logkey: 'auto-exp-id',   // 埋点方案中对应的事件编码
          props: ['data-pagename', 'data-page_title'], // 你要曝光的元素身上自定义属性
      },
     //采集列表元素的曝光行为
      {
          cssSelector: '.autoexp-list-item', 
          logkey: 'auto-exp-item', // 埋点方案中对应的事件编码
          props: ['data-name'], // 自动曝光会携带item的name字段
      },
    ],
  ],
});

//自动曝光的前置回调函数，用于支持定制化参数上报，如驼峰写法等（html数据属性默认只支持小写）
//1.9.25版本及以上支持
aplus_queue.push({
  action: 'aplus.setMetaInfo',
  arguments: ['aplus-auto-exp-userfn', function(e) {
    if (e.className.indexOf('autotrack_exp_web') != -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 {
        userdata: obj
      };
    }
  }]
});

如果是元素内滚动（某个区块内有滚动条）则需要增加positionSelector配置，参考以下代码

aplus_queue.push({
  action: 'aplus.setMetaInfo',
  arguments: ['aplus-auto-exp',[{
    positionSelector: '.content-wrap',  // 你的滚动条元素class
        cssSelector: '.autoclk-app-option', // 你要曝光的元素class 
        logkey: 'auto-exp-id',  // 埋点方案中对应的事件编码
        props: ['data-name'], // 元素身上自定义属性
      },
    ],
  ],
});

SDK在单页应用中，当存在页面离开后又返回的场景时，会再次重复上报曝光事件，如果需要关闭此默认行为，可以通过设置：

aplus_queue.push({
  action: 'aplus.setMetaInfo',
  arguments: ['aplus-exposure-event-can-repeat', false]
});

aplus-exposure-event-can-repeat metaInfo的默认值是true，即支持重复上报曝光事件.

备注：aplus-exposure-event-can-repeat API仅在v1.10.2版本及以上生效，该版本以下自动曝光事件的默认行为仍然是单页应用只要页面不被重新加载，页面已曝光的元素，再次回到当前页面时不会再次曝光。

7.5 自动点击（全埋点）

从1.7.0开始，为减少开发者埋点工作量，sdk也支持通过配置部分信息，让SDK自动采集页面内的点击事件。

<body>
  <div id="root">
    <h1 class="title">Demo</h1>
    <!-- 1.首先定位待上报事件的html元素的class -->
    <!-- 2.如果需要传递参数，通过html的数据属性传递 data-*的方式,请使用小写字母组合定义参数 -->
    <button 
       class='autoclk-component-css' 
       data-aparam="1" 
       data-pagename="自定义当前事件的页面编码"
       data-page_title="自定义当前事件的页面标题">
      测试点击
    </button>
    <li 
      className='autotrack_clk_web' 
      data-itemname='读书'
      data-itemzoon='abc' 
      data-itemid='a_product_id' 
      data-promotioninformation='abc' 
      data-pagename='首页'>自动点击</li>
  </div>
</body>

sdk 配置部分：

aplus_queue.push({
  action: 'aplus.setMetaInfo',
  arguments: ['aplus-auto-clk', [{
        cssSelector: '.autoclk-component-css', //元素的class 
        logkey: 'auto-clk-id',  //埋点方案中对应的事件编码
        props: ['data-aparam', 'data-pagename', 'data-page_title'], // 元素身上自定义属性
      },
    ],
  ],
});

//自动点击的前置回调函数，用于支持定制化参数上报，如驼峰写法等（html数据属性默认只支持小写）
//1.9.25版本及以上支持
aplus_queue.push({
  action: 'aplus.setMetaInfo',
  arguments: ['aplus-auto-clk-userfn', function(e) {        
    if (e.className.indexOf('autotrack_clk_web') != -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 {
        userdata: obj
      };
    }
  }]
});

7.6 任意控件点击自动捕获（全埋点）

7.6.1 全埋点开关

通过设置aplus-autotrack-enabled 为true，开启全埋点功能，默认为开启，指定为false关闭本地全埋点功能

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

7.6.2 全埋点控件配置

web sdk 默认只采集 a、button、textarea、input 这4个html控件的点击事件，如若需要额外采集其他类型控件，可通过额外配置aplus-autotrack-config进行配置

aplus_queue.push({
  action: 'aplus.setMetaInfo',
  arguments: ['aplus-autotrack-config', {
    collect_tags: {
      li: true, //采集<li/>控件
      img: true,//采集<img/>控件
      svg: true,//采集<svg/>控件
      div: true,//采集<div/>控件
      span: true,//采集<span/>控件
      path: true,//采集<path/>控件
      p: true //采集<p/>控件
    },
    collect_input: true, //采集input框输入的内容，默认不采集,
    element_capture_enable: true //全埋点控件点击支持事件捕获模式，默认为冒泡模式，值为false
  }]
});

7.6.3 全埋点事件的属性上报

同自动事件的属性上报，借助html数据属性上报

<body>
  <div id="root">
    <!-- 如果需要传递参数，通过html的数据属性传递 data-*的方式 -->
    <button data-aparam="1">测试点击</button>
  </div>
</body>

7.6.4 单个控件关闭全埋点事件上报

如果期望关闭某个控件的事件上报，通过添加控件属性aplus-autotrack-off为true关闭上报

<body>
  <div id="root">
    <!-- 如果需要传递参数，通过html的数据属性传递 data-*的方式 -->
    <button data-aparam="1" aplus-autotrack-off="true">
      配置了aplus-autotrack-off的组件不上报
    </button>
  </div>
</body>

7.6.5 单个控件自定义事件编码

通过data-clk-logkey自定义事件编码

<button data-clk-logkey="demoEventCode">通过data-clk-logkey自定义事件编码</button>

8 热力图

8.1 热力图能力开关

sdk默认关闭热力图能力，如需打开通过如下配置：

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

或者

<meta name="aplus-heatmap-enabled" content="1">

8.2热力图事件采样率

热力图事件采样率最小支持千分位小数

aplus_queue.push({
 action: 'aplus.setMetaInfo',
 arguments: ['aplus-rate-ahot', 0.001] //热力图事件采样率 最小支持千分位小数
});

或者

<meta name="aplus-rate-ahot" content="0.001">