团队研发文档

开发规范、技术文档等


小程序SDK2.0

<h3>发送日志示例 (已urlcode解码)</h3> <div style="background-color:#EBEEF5;padding:20px;color:#000;font-weight:400"> 【et=0】 【et=1】 【et=2】 【et=3】 【et=4】 【et=5】 【et=9】 【et=10】 </div> <h3>SDK字段说明</h3> <table> <thead> <tr> <th style="text-align: left;">字段</th> <th style="text-align: left;">字段说明</th> <th style="text-align: left;">备注</th> <th style="text-align: left;">et值</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">at</td> <td style="text-align: left;">app type</td> <td style="text-align: left;">0:app,1:h5, 2:公众号</td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">aid</td> <td style="text-align: left;">应用ID</td> <td style="text-align: left;">监测站点ID,区分不同监测项目</td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">bid</td> <td style="text-align: left;">品牌id</td> <td style="text-align: left;">app所属的品牌ID</td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">cid</td> <td style="text-align: left;">会话id</td> <td style="text-align: left;">新打开一次小程序为一次会话</td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">oid</td> <td style="text-align: left;">用户openid</td> <td style="text-align: left;"></td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">uid</td> <td style="text-align: left;">用户unionid</td> <td style="text-align: left;"></td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">et</td> <td style="text-align: left;">事件类型</td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">ep</td> <td style="text-align: left;">事件描述</td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">os</td> <td style="text-align: left;">系统</td> <td style="text-align: left;"></td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">v</td> <td style="text-align: left;">SDK版本</td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">pt</td> <td style="text-align: left;">页面标题</td> <td style="text-align: left;">pageTitle</td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">su</td> <td style="text-align: left;">来源url</td> <td style="text-align: left;">refferURL</td> <td style="text-align: left;">et=1</td> </tr> <tr> <td style="text-align: left;">u</td> <td style="text-align: left;">当前url</td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">utm</td> <td style="text-align: left;">推广渠道编码</td> <td style="text-align: left;"></td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">scene</td> <td style="text-align: left;">场景值</td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">utp</td> <td style="text-align: left;">渠道类型标识</td> <td style="text-align: left;">1.普通渠道;2.KOL</td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">ro</td> <td style="text-align: left;">根用户openid</td> <td style="text-align: left;">root openid</td> <td style="text-align: left;">?</td> </tr> <tr> <td style="text-align: left;">po</td> <td style="text-align: left;">上级用户openid</td> <td style="text-align: left;">parent openid</td> <td style="text-align: left;">?</td> </tr> <tr> <td style="text-align: left;">ru</td> <td style="text-align: left;">根用户unionid</td> <td style="text-align: left;">root unionid</td> <td style="text-align: left;">?</td> </tr> <tr> <td style="text-align: left;">pu</td> <td style="text-align: left;">上级用户unionid</td> <td style="text-align: left;">parent unionid</td> <td style="text-align: left;">?</td> </tr> <tr> <td style="text-align: left;">wn</td> <td style="text-align: left;">当前层级</td> <td style="text-align: left;">小程序为空</td> <td style="text-align: left;">?</td> </tr> <tr> <td style="text-align: left;">net</td> <td style="text-align: left;">网络类型(2g,3g,4g,wifi)</td> <td style="text-align: left;">net work</td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">ua</td> <td style="text-align: left;">UserAgent信息</td> <td style="text-align: left;">解析到os、net</td> </tr> <tr> <td style="text-align: left;">nn</td> <td style="text-align: left;">用户昵称</td> <td style="text-align: left;">nickName</td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">au</td> <td style="text-align: left;">用户头像URL</td> <td style="text-align: left;">avatorUrl</td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">ge</td> <td style="text-align: left;">性别</td> <td style="text-align: left;">gender</td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">ci</td> <td style="text-align: left;">城市</td> <td style="text-align: left;">city</td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">pr</td> <td style="text-align: left;">省份</td> <td style="text-align: left;">province</td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">cy</td> <td style="text-align: left;">国家</td> <td style="text-align: left;">country</td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">rqn</td> <td style="text-align: left;">日志序号</td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">ww</td> <td style="text-align: left;">屏幕宽度</td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">wh</td> <td style="text-align: left;">屏幕高度</td> <td style="text-align: left;">all</td> </tr> <tr> <td style="text-align: left;">lp</td> <td style="text-align: left;">会话落地页</td> <td style="text-align: left;">landing page</td> <td style="text-align: left;">et=1</td> </tr> </tbody> </table> <h3>事件说明</h3> <table> <thead> <tr> <th style="text-align: left;">事件名称</th> <th style="text-align: left;">事件类型(et)</th> <th style="text-align: left;">事件描述(ev)</th> <th style="text-align: left;">说明</th> <th style="text-align: left;">备注</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">应用曝光</td> <td style="text-align: left;">0</td> <td style="text-align: left;">无</td> <td style="text-align: left;">站点曝光</td> <td style="text-align: left;">会话开始时触发</td> </tr> <tr> <td style="text-align: left;">页面曝光</td> <td style="text-align: left;">1</td> <td style="text-align: left;">页面名称</td> <td style="text-align: left;">页面曝光</td> <td style="text-align: left;">进入页面时触发</td> </tr> <tr> <td style="text-align: left;">SDK自定义事件</td> <td style="text-align: left;">100-999</td> <td style="text-align: left;">日志参数[]</td> <td style="text-align: left;">SDK自定义事件,ev为空[],当前自定义事件编码见附1</td> </tr> <tr> <td style="text-align: left;">热力图座标事件</td> <td style="text-align: left;">3</td> <td style="text-align: left;">获取鼠标点击页面坐标,如果点击的是a标签,格式为:[{x:10,y:100,t:a,u:<a href="http://www.baidu.com}],如果点击的是非a标签,格式为:[{x:10,y:100,t:b">http://www.baidu.com}],如果点击的是非a标签,格式为:[{x:10,y:100,t:b</a>}]</td> <td style="text-align: left;">获取点击页面坐标</td> </tr> <tr> <td style="text-align: left;">页面关闭事件</td> <td style="text-align: left;">4</td> <td style="text-align: left;">停留时长+激活时长:用 <code>,</code>分隔</td> <td style="text-align: left;">页面停留时间, <br>例: '10533,2082'</td> <td style="text-align: left;">停留时长(从进入页面到离开页面)和激活时长(从页面开始加载到加载结束)(小程序的加载时长赞为0)</td> </tr> <tr> <td style="text-align: left;">用户自定义事件</td> <td style="text-align: left;">&gt;=1000</td> <td style="text-align: left;">[ {k:'key1 ',v: 'val1' }, {k:'key2 ',v: 'val2' } ]</td> <td style="text-align: left;">支持最多10组自定义属性字段</td> </tr> <tr> <td style="text-align: left;">分享事件参数</td> <td style="text-align: left;">9</td> <td style="text-align: left;">分享类型</td> <td style="text-align: left;">[ {k:type,v: 'friend' } ]</td> </tr> <tr> <td style="text-align: left;">滚动监测事件</td> <td style="text-align: left;">10</td> <td style="text-align: left;">{&quot;top1&quot;:39,&quot;bottom1&quot;:1245,&quot;top2&quot;:39,&quot;bottom2&quot;:1245,&quot;ah&quot;:1257,&quot;st&quot;:0,&quot;dt&quot;:3341}</td> <td style="text-align: left;">top1和bottom1代表滚动前区域位置,top2和bottom2是滚动停止时的区域位置,st为滚动操作时间,dt为top1到bottom1区域的停留时长,ah为页面高度,样例见附2</td> </tr> </tbody> </table> <p>附1:</p> <table> <thead> <tr> <th>et</th> <th>说明</th> <th>原编码</th> </tr> </thead> <tbody> <tr> <td>101</td> <td>事件报错</td> <td>mz_error_message</td> </tr> <tr> <td>102</td> <td>下拉刷新</td> <td>mz_pulldownrefresh</td> </tr> <tr> <td>103</td> <td>滚动触底</td> <td>mz_reachbottom</td> </tr> <tr> <td>104</td> <td>分享事件</td> <td>mz_share_chain</td> </tr> <tr> <td>105</td> <td>小程序退出</td> <td>无</td> </tr> </tbody> </table> <p>附2: 滚动事件测试样例</p> <p>1.页面A滚动 {&quot;top1&quot;:0,&quot;bottom1&quot;:1206,&quot;top2&quot;:295,&quot;bottom2&quot;:1501,&quot;ah&quot;:3233,&quot;st&quot;:500,&quot;dt&quot;:3197}</p> <p>2.页面A滚动 {&quot;top1&quot;:295,&quot;bottom1&quot;:1501,&quot;top2&quot;:699,&quot;bottom2&quot;:1905,&quot;ah&quot;:3233,&quot;st&quot;:501,&quot;dt&quot;:4433}</p> <p>3.页面A退出 {&quot;top1&quot;:699,&quot;bottom1&quot;:1905,&quot;top2&quot;:699,&quot;bottom2&quot;:1905,&quot;ah&quot;:3233,&quot;st&quot;:0,&quot;dt&quot;:3133}</p>

页面列表

ITEM_HTML