1.0.1 • Published 2 years ago

@alipay-inc/mpaas-mtracker-wxmini v1.0.1

Weekly downloads
-
License
MIT
Repository
gitlab
Last release
2 years ago

配置

1、安装npm包

npm install @alipay-inc/mpaas-mtracker-wxmini

2、引入npm包

import { Tracker } from '@alipay-inc/mpaas-mtracker-wxmini';

初始化

Tracker.init({
  server: 'https://cn-hangzhou-mas-log.cloud.alipay.com/loggw/webLog.do', // 必填,接受埋点的服务地址
  appId: 'xxxxxxxxxx', // 必填,App 唯一标识
  workspaceId: 'default', // 必填,环境标识
  userId: '1234567890',      // 选填, 默认为空
  bizScenario: 'alipay',   // 选填,渠道来源,默认为空
  mtrDebug: true, // 选填,是否开启 mtracker 的 debug 模式,在 debug 模式下会打印上报的日志,默认为 false 不开启
  extendParams: { test: 111 } // 选填,全局扩展参数,默认为空,1.1.0 版本以上支持
});

接口

Tracker.click(eventId, options)

描述:点击埋点

Tracker.click('a1-b1', {
  bizType: 'Pay',
  ext: {
    productId: 'xxx'
  }
})

eventId

  • 释义:事件ID
  • 类型:String
  • 示例:
a1-b1

options

bizType
  • 释义:业务码
  • 类型:String
  • 示例:
Pay
ext
  • 释义:扩展参数
  • 类型:Object
  • 示例:
{
  productId: 'xxx'
}

Tracker.expo(eventId, options)

描述 曝光埋点

Tracker.expo('a1-b1', {
  bizType: 'Pay',
  ext: {
    productId: 'xxx'
  }
})

eventId

  • 释义:事件ID
  • 类型:String
  • 示例:
a1-b1

options

bizType
  • 释义:业务码
  • 类型:String
  • 示例:
Pay
ext
  • 释义:扩展参数
  • 类型:Object
  • 示例:
{
  productId: 'xxx'
}

Tracker.setUserId(userId)

Tracker.setUserId('xxx');

Tracker.changeTrackerExtendParams(ext)

描述 改变全局扩展参数

该功能自 1.1.0 版本起支持,如需使用该功能请升级

Tracker.changeTrackerExtendParams({
    productId: 'xxx'
})
ext
  • 释义:扩展参数
  • 类型:Object
  • 示例:
{
  productId: 'xxx'
}

预置扩展属性

属性ID说明
userAgent-(微信小程序内获取不到,故置为-)
fullURL当前页面的完整 URL
mBizScenario渠道来源

埋点格式

点击埋点

序号字段名字段值(示例)
01日志头D-VM(固定值)
02当前时间2020-02-12 20:12:20
03客户端ID应用 ID_H5-workspaceId
04微信客户端版本号1.0.0
05日志埋点SDK版本2(固定值)
06终端ID-
07会话IDd5557b75-ff80-4aab-86a6-9b1a522bbbce(生成uuid,存放在appInstance.globalData)
08uid1234567890
09eventclick(固定值)
10-
11上一级页面 ID|上一级页面位置 IDurl|postion
12-
13-
14-
15-
16seedIdPayResults
17-
18业务码Pay (默认值:UserBehaviorH5)
19-
20-
21-
22-
23扩展字段k=v^k=v
24-
25-
26utdidWn1111111111111111111QxL (guid-timestamp )
27-
28-
29-
30-
31-
32-
33-
34设备型号SM-N9500
35操作系统版本iOS
36-
37-
38-
39操作系统语言en
40-
41CPU 核数-
42-
43-
44-
45-
46分辨率1920x1200
47-
48-

曝光埋点

序号字段名字段值(示例)
01日志头D-VM(固定值)
02当前时间2020-02-12 20:12:20
03客户端ID应用 ID_H5-workspaceId
04微信客户端版本号1.0.0
05日志埋点SDK版本2(固定值)
06终端ID-
07会话IDd5557b75-ff80-4aab-86a6-9b1a522bbbce(生成uuid,存放在appInstance.globalData)
08uid1234567890
09eventexposure(固定值)
10-
11上一级页面 ID|上一级页面位置 IDurl|postion
12-
13-
14-
15-
16seedIdPayResults
17-
18业务码Pay (默认值:UserBehaviorH5)
19-
20-
21-
22-
23扩展字段k=v^k=v
24-
25-
26utdidWn1111111111111111111QxL (guid-timestamp )
27-
28-
29-
30-
31-
32-
33-
34设备型号SM-N9500
35操作系统版本iOS
36-
37-
38-
39操作系统语言en
40-
41CPU 核数-
42-
43-
44-
45-
46分辨率1920x1200
47-
48-

页面打开自动化埋点

序号字段名字段值(示例)
01日志头D-VM(固定值)
02当前时间2020-02-12 20:12:20
03客户端ID应用 ID_H5-workspaceId
04微信客户端版本号1.0.0
05日志埋点SDK版本2(固定值)
06终端ID-
07会话IDd5557b75-ff80-4aab-86a6-9b1a522bbbce(生成uuid,存放在appInstance.globalData)
08uid1234567890
09eventauto_openPage(固定值)
10-
11上一级页面 ID|上一级页面位置 IDurl|postion
12-
13-
14-
15-
16当前页面URLhttps://d.alipay.com
17-
18业务码Pay (默认值:UserBehaviorH5)
19-
20-
21-
22-
23扩展字段(仅包含预置属性)k=v^k=v
24-
25-
26utdidWn1111111111111111111QxL (guid-timestamp )
27-
28-
29-
30-
31-
32-
33-
34设备型号SM-N9500
35操作系统版本iOS
36-
37-
38-
39操作系统语言en
40-
41CPU 核数-
42-
43-
44-
45-
46分辨率1920x1200
47-
48-