埋点JS调用说明

                                           

1、埋点编码申请


文档已更新至 数据埋点,本网站以后不再维护,请自行移步到新地址


1.每家分行仅限指定一位专职对接埋点管理平台的经办产品经理,向“招商银行小程序管理”邮箱(xiaochengxu@cmbchina.com)发送埋点权限申请:提供经办人员6位一事通ID,描述准备进行埋点的具体小程序需求。


2.总行小程序业务管理人员受理权限申请需求,并在T+1工作日内安排给分行埋点经办人员开通埋点管理平台权限,同时发送埋点管理平台简介、埋点编码要求、站内埋点规范、埋点流程等文档。


3.分行埋点经办人员结合小程序功能实际需求,明确埋点方案,在埋点管理平台上提交新增页面。总行小程序业务管理人员审核新增页面,与分行沟通修改,直到通过方案。


4.分行埋点经办人员输出埋点方案。提交开发人员进行开发。


2、前端埋点js引入

调用页面埋点之前需要引入behavior.min.js 和jquery.min.js,其中jquery.min.js可以到JQuery官网下载最新版本即可, behavior.min.js如附件(注:behavior.min.js的使用需要在招商银行app内场景使用,并且客户端版本需要在7.0.0以上)


behavior.min.js  更新时间:2019-01-04



开启debug模式方法为页面上添加:CMBLS.CMBAppLogEx.debug = true;

默认为关闭,当测试完毕需要关闭debug模式时,删除页面上:CMBLS.CMBAppLogEx.debug = true。

注:开启debug模式,埋点提交成功或失败结果会通过alert窗口提示。

3、页面加载日志pageload埋点

页面编号埋点需要在页面加载的时候调用页面埋点的js方法实现,方法如下:

CMBLS.RecordPageLoadLog("xxx");

其中xxx 是页面编码,一般都是由三位字母组成。调用该方法一般在

$(function() {
CMBLS.RecordPageLoadLog("xxx");
});

或者:

$.MReady(function () {
CMBLS.RecordPageLoadLog("xxx");
});

中调用。

4、页面控件点击日志ClickUnload埋点

该埋点方式一般用于点击事件中,需要记录客户的某个点击事件,调用事件为:

CMBLS.RecordClickUnloadLog("widgetno","prodcode","widgetstatus");

事件中三个参数分别是:"widgetno" , "prodcode","widgetstatus"

widgetno:事件元素ID,一般组成三个字母和六位数字组成

prodcode:产品编码,该字段可以记录该功能的产品或者编码(一般少用到,例如基金编码等)

widgetstatus:事件状态,比如按钮的开关可以通过设置0或者1来区分

该方法的调用并不是每次都需要传三个参数,按需传递,假如只需要widgetno,直接调用

CMBLS.RecordClickUnloadLog("widgetno");

该方法一般用于点击触发事件中。


5、页面控件点击日志ClickUnload埋点(自定义参数)

如果需要自定义参数,可以通过以下方法自定义参数:

var option = {
widgetno:"xxx",
widgetname:"xxx",
ItemLogID: "xxx"//例:自定义字段ItemLogID
}

调用方式为:

CMBLS.RecordClickUnloadLog.call(option);


6、页面控件点击日志ClickUnload埋点(自定义参数)

如果在A页面点击按钮跳转到B页面,需要在跳转到B页面的链接后面加上参数behavior_entryid= xxx ,参数的值为A页面点击按钮的编码(一般组成由三位字母和六位数字组成),加上behavior_entryid= xxx 的作用是为了B页面在调用pageload的时候,会把behavior_entryid的值和pageno保存到同一条日志记录里面,这样就可以识别该页面的跳转来源。


7、埋点结果查看指引

1.分别在iOS和Android测客户端中打开上传埋点按钮,并且输入ip和端口,样例如下图红框的内容(生产客户端不需要担心该问题,已经默认配置好)


2.内部网ST环境上图红框部分填写ip或host为99.12.88.17 ,端口范围为:811 ~830,查看日志的FTP地址为:

路径:ftp://99.12.88.17/

账号:ftpuser

密码:Cmb147258

日志存放路径:

ftp://99.12.88.17/MbankLogColl_(端口)/config/CmbBank_Mobile/buslog/UserLog/behavior_日期.txt


3.内部网UAT环境上图红框部分ip或host为99.12.87.157,端口范围为:80,查看日志的FTP地址为:

路径:ftp://99.12.87.157/

账号:ftpuser

密码:Cmb147258

日志存放路径为:ftp://99.12.87.157/MbankLogColl_80/config/CmbBank_Mobile/buslog/UserLog/behavior_日期.txt


4.外网ST环境上图红框部分ip或host为121.15.180.72,端口范围为:80,查看日志的FTP地址为:

路径:ftp://99.12.228.252/MbankLogColl_80/

账号:test

密码:tester123

日志存放路径为:

ftp://99.12.228.252/MbankLogColl_80/config/CmbBank_Mobile/buslog/UserLog/behavior_日期.txt


5.外网UAT环境上图红框部分ip或host为121.15.180.72,端口范围为:801,查看日志的FTP地址为:

路径:ftp://99.12.228.252/HTMLUAT_Log

账号:test

密码:tester123

日志存放路径为:

ftp://99.12.228.252/HTMLUAT_Log/config/CmbBank_Mobile/buslog/UserLog/behavior_日期.txt


根据自己的埋点编号在埋点日志文件中搜索内容,能够查到埋点日志记录即为埋点成功(注:ftp打不开或者账号密码不对请咨询:王安森)