概述
代码埋点是一种广泛用于跟踪和记录在应用程序、网站或其他软件中发生的特定事件的方法。通过在代码中插入NEXUS SDK的代码片,开发人员可以捕获用户与应用程序交互的各种行为和事件,例如页面浏览、按钮点击、表单提交等。通过代码埋点,开发人员可以定义和跟踪他们认为重要的事件,以便后续分析和评估。NEXUS EDT 支持用户在web端,小程序端,以及安卓,ios端的代码埋点上报以及后端业务上报。
在进行代码埋点上报之前,使用者需要完成以下步骤:
- 完成事件所涉及到的事件属性和用户属性的定义
- 创建完成事件归属的项目和平台信息。
- 在后台按照规则完成事件结构的定义。
操作步骤
创建代码埋点
在事件管理-代码埋点管理中,用户可以创建埋点事件的数据结构,通常用户会预先规划好埋点数据的结构。通常业务人员会
以下是各类埋点事件的特征,通常在代码埋点中,主要的事件类型有点击、浏览、登入,登出等,冷热启动页会作为全埋点事件,加入到埋点体系。
创建代码埋点事件
点击右上方创建按钮,可以在系统中创建代码埋点事件,创建时,系统会自动带上页面上的筛选参数便于用户创建事件。用户点击后创建埋点。
字段 | 说明 |
---|---|
所属项目 | 事件归属的项目,根据事件列表代入 |
事件编码 | 用户可以自定义填入事件编码,或通过系统自动化生成时间编码。 |
所属产品 | 根据列表上信息代入,是用户在产品管理中创建的产品。 |
页面名称 | 根据用户在右针对产品定义的页面信息来定义 |
页面ID | 系统根据页面创建时生成的id自动填入,根据此id事件上报数据和页面相互关联。 |
事件状态 | 上报/ 不上报 ,选择不上报,事件会被数据处理中丢弃 |
上报时机 | 根据事件类型定义,click在单机时,page view在用户离开页面时。 |
埋点方式 | 根据所选类型定义,此处为代码埋点。 |
备注 | 备注事件信息 |
预制属性和扩展属性
用户在创建事件时,根据事件来源平台,事件类型,系统会报帮助用户选取所需要的上报的预制属性。部分的预制属性是必传字段,如果没有上报,则改条事件会被系统定义为错误事件,同时记录错误码。预制属性可见预制属性表。当预制属性无法满足用需求的时候,可以在用户属性管理和事件属性管理中,自定义添加新的属性。
在页面上用户仅需要在拓展属性的框内,
埋点设计
以下是提取了某个内部项目的埋点示例,业务同学需要预先进行埋点设计,预先规划项目中用户的业务流程,可以参照某商城的埋点业务逻辑设计,以及某商城埋点方案示例。
附1:埋点设计示例:
通常需要用户规划好事件编码,事件信息,以及事件的页面位置,系统会自动初始化推荐事件需要的默认属性,并且将事件的附加属性,提前进行规划,一遍在后台进行添加。
事件编码 | 事件【页面名称】 | 事件【页面ID】 | 事件名称 | 事件类型 | 当前事件所属页面url | 元素 | 上级各层级页面 | 直接上级页 | 上报时机 | 备注:埋点对象 | 截图 | 拓展字段 |
---|---|---|---|---|---|---|---|---|---|---|---|---|
dc_0000001 | 创略商城-首页 | front_page | 商城首页-浏览 | view_page | /pages/index/index | 无 | 无 | 无 | 浏览结束 | 商城首页-页面 | ![]() | {"name":"绑定手机号","fieldName":"phoneNumber"} {"name":"用户名","fieldName":"userid"} |
dc_0000002 | 创略商城-首页 | front_page | 商城首页-新品推荐按钮-点击 | click | /pages/index/index | uni-view.item | 无 | 无 | 单击时 | 商城首页-新品推荐按钮 | ![]() | {"name":"绑定手机号","fieldName":"phoneNumber"} {"name":"用户名","fieldName":"userid"} |
dc_0000003 | 创略商城-首页 | front_page | 商城首页-限时特惠按钮-点击 | click | /pages/index/index | uni-view.item | 无 | 无 | 单击时 | uni-view.item | {"name":"绑定手机号","fieldName":"phoneNumber"} {"name":"用户名","fieldName":"userid"} | |
dc_00000010 | 新品推荐页 | prod-classify | 新品推荐页-浏览 | view_page | /pages/prod-classify/prod-classify?sts=1 | 无 | 创略商城-首页 | 创略商城-首页 | 浏览结束 | 商城首页-新品推页面 | ![]() | {"name":"绑定手机号","fieldName":"phoneNumber"} {"name":"用户名","fieldName":"userid"} {"name":"商品id","fieldName":"productid"} |
附2:各类埋点事件特征
各类埋点事件特征 | ||||||
---|---|---|---|---|---|---|
类型 | 中文名称 | 事件及细节举例说明 | 上报时机 | 上报时机 | 事件说明 | 备注 |
click | 点击 | 点击 | 单击时 | 微信小程序、H5所有事件在采集后实时上报,未上报成功,则会缓存,待下次事件上报时一同上报 | 一般用户点击元素抓取到响应即算点击事件,不管点击后有无结果,点击一次记一次事件。 | |
输入框点击 | 聚焦一次记一次 | |||||
view_page | 浏览 | 浏览 | 离开页面时 | 每进入页面,并离开页面,记一次浏览 | ||
浏览时长 | 进入页面和退出页面的时间差 | |||||
custom | 自定义 | 用于自定义单个元素或多个元素组的操作行为事件(不属于click、view_page类型的事件) | 代码埋点事件定义时写的上报时机 | 包括但不限于以下场景: 1、当前页面中滑动操作时某些元素或元素组合的展现; 2、刷新页面后的展现; 3、进入或加载页面后的展现; 4、home键切换至后台后再进入页面的展现; 5、诸如banner之类的元素自动滚动曝光展现; 6、其他复杂情况操作场景; | ||
login | 登录 | 用户通过微信/ 手机号登录 | 用户登录时 | |||
logout | 登出 | 用户退出小程序/ H5 | 用户登出时 | |||
cold_start | 冷启动 | cold_start (冷启动) | 冷启动时 | 微信小程序onLaunch为冷启动;小程序统称为启动 | Web/H5无此事件类型 | |
hot_start | 热启动 | hot_start (热启动) | 热启动时 | 微信小程序onShow为热启动; | Web/H5无此事件类型 | |
use_end | 使用结束 | use_end(使用结束) | 用户单次使用结束 | 用户使用结束时上报,微信小程序关闭调用onHide方法时上报; | Web/H5无此事件类型 |