简介
kd-counter
是一个用于网页浏览器端页面埋点的 npm 包。它可以方便地帮助我们捕捉我们关心的行为,并把这些行为发送到指定的数据收集平台。该包支持自定义事件类型,捕获元素信息、用户信息、页面信息等浏览器端相关内容。
安装
安装包
npm install kd-counter --save
引入
import kdCounter from 'kd-counter';
使用
在页面加载时初始化,可以在 mounted
钩子或 created
钩子中进行初始化,如下示例:
-- -------------------- ---- ------- ------ ------- - --------- - ---------------- ---- ------------------------------- -- -------- ------ -------------- -- ---- --------- - -- ---- ------- ------ --------- ---------- -- ------- --------------- -- ---- --- -- --
API
kdCounter.init(options)
初始化 kd-counter
实例。
初始化选项:
url
:字符串类型,必选参数,数据收集平台接口地址。appId
:字符串类型,必选参数,应用唯一标识。userInfo
:对象类型,可选参数,包括:userId
:字符串类型,用户唯一标识。userName
:字符串类型,用户名称。
pageId
:字符串类型,可选参数,页面唯一标识。
kdCounter.track(eventName[, elementInfo[, properties]])
埋点方法,用于追踪行为。
参数:
eventName
:字符串类型,必选参数,事件名称,用于描述该事件。elementInfo
:对象类型,可选参数,包括:elementId
:字符串类型,元素唯一标识;elementName
:字符串类型,元素名称。
properties
:对象类型,可选参数,包括:prop1
:字符串类型,事件属性1;prop2
:字符串类型,事件属性2;- ...
可以在需要进行埋点的页面中使用 kdCounter.track()
函数。示例如下:
-- -------------------- ---- ------- ------- ---------- ------------ -------------------------- ----------- ------ ------- - -------- - ------------- - ------------------------------- - ---------- ---------- ------------ ------- --- -- - ------ --------- --- -- -- --
示例
初始化:
-- -------------------- ---- ------- ---------------- ---- ------------------------------- ------ -------------- --------- - ------- ------ --------- ---------- -- ------- --------------- ---
埋点:
-- -------------------- ---- ------- ------- ---------- ------------ -------------------------- ----------- ------ ------- - -------- - ------------- - ------------------------------- - ---------- ---------- ------------ ------- --- -- - ------ --------- --- -- -- --
总结
kd-counter
是一款不错的 npm 包,它提供了浏览器端页面埋点的功能,方便我们统计关键行为数据。通过本文的介绍,相信读者已经掌握了该 npm 包的使用方法。同时,也建议在实际项目中使用该包时,结合项目需求进行修改。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066efb4c49986ca68d893b