teemos v1.0.2

提莫-斥候

预置事件

1. $click
2. $pageview
3. $pagestay

预置事件可以通过配置自动开启。 也可以调用方法手动开启。

属性

以 $ 开头的属性都为原有预置属性，为了便于区分，请在添加额外预置属性时，属性名不要以 $ 开头。

全局非埋点属性

$evt    # Event 事件类型
$vid    # VisitorId 访问者id
$uid    # UserId 用户ID

全局预置属性

$sdk      # sdk 类别，值为 web
$sdk_v    # sdk 版本
$lang     # 浏览器语言
$os       # 系统
$os_v     # 系统版本
$br       # 浏览器品牌
$br_v     # 浏览器版本
$eng      # 浏览器引擎
$title    # 页面 title
$origin   # 页面 origin
$path     # 页面 path
#search   # 页面路径查询字符串
$hash     # 页面 hash
$clnt_ts  # 客户端侧时间戳
$scr_w    # 屏幕宽度
$scr_h    # 屏幕高度
$scr_ori  # 屏幕方向

$click 事件预置属性

$el_tag     # 元素 tag
$el_id      # 元素属性 id
$el_name    # 元素属性 name
$el_cls     # 元素属性 class
$el_href    # 元素属性 href
$el_ct      # 元素内容，最多85个字符
$el_sel     # 元素选择器
$page_x     # 点击的页面x轴坐标
$page_y     # 点击的页面y轴坐标

$pageview 事件预置属性

$ref # 来源页面

$pagestay 页面停留预置属性

$du # 页面停留时间，单位秒

Methods

init(options)

// 初始化方法

// options
{
  // 数据源服务地址，必填
  dsn: '',
  // 发送方式: beacon, image，默认beacon
  send_type: 'beacon',
  // 是否自动收集页面浏览事件，默认开启
  pageview_auto_trace: true,
  // 是否自动收集页面停留事件，默认开启
  pagestay_auto_trace: true,
  // 是否自动收集hashchange事件，默认关闭
  hashchange_auto_trace: false,
  // 是否自动收集点击事件，默认开启
  click_auto_trace: true,
  // 收集包含有特定属性的元素的点击
  click_attr_trace: [],
  // 收集包含有特定类名的元素的点击
  click_class_trace: [],
  // 是否开启收集兜底事件触发元素的点击，默认不开启
  click_target_trace: false,
  // 是否开启调试
  debug: false,
  // 访问者ID，代表客户端代理
  vid: '',
  // 用户ID，用于绑定用户ID
  uid: '',
};

trace(eventName, payload, callback)

// 发送自定义事件

// eventName 事件名称
// payload 额外的信息负载
// callback 事件的回调函数

traceClick(event, payload, callback)

// 手动触发$click事件

// event 点击时的事件对象
// payload 额外的信息负载

tracePageview(payload, callback)

// 手动触发spa应用$pageview事件

// payload 额外的信息负载

tracePagestay(payload, callback)

// 手动触发页面停留事件，只收集停留时间大于4s的情况

setPageStartTime(timestamp)

// 手动设置页面开始访问时间

addPresetState(name, value)

// 添加额外的全局预置属性
// name 预置属性名称
// value 预置属性值

setUserId(uid)

// 手动设置 $uid ，表示当前用户

setVisitorId(id)

// 设置访问者ID，代表当前客户端代理

setUserid(id)

自动收集 $click 点击事件介绍

只收集从事件 target 向父级查找最多10层元素； 默认 $click 点击事件遵循以下规则，优先级依次递减。

1. contenteditable, input, textarea 元素
2. a 元素
3. 包含特定 attr, class 的元素
4. cursor 属性值为 pointer 的元素
5. button 元素
6. click_target_trace: true 时点击事件的 target 元素

注意：

1. 不收集 body html 元素的点击事件
2. click_target_trace: true 表示每次点击都会有兜底的 target 元素，作为点击信息上报元素。