# burying-point

**Repository Path**: r_q/burying-point

## Basic Information

- **Project Name**: burying-point
- **Description**: 微信小程序埋点项目，根据需求修改即可
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-12-20
- **Last Updated**: 2024-05-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# burying-point-rice

#### 介绍

小程序埋点系统，实例化后可以通过传入 `appid` 和接口地址进行数据统计，**电脑上使用可能会与实机有差异，一切以真机为准**
这里可以联系我的`v`，提供源码进行修改：`rice_706`
**说一下项目内都是怎么样的，具体事件**

> 1.页面会记录首次启动小程序的时间（$ae_app_open）
>
> 2.页面从前台进入会记录时间（$ae_app_start）, 离开进入后台挂载会记录此次运行时常（$ae_app_terminate）
>
> 3.当前页面浏览时常,重写了 onshow,onhide,onunload，静默记录（$ae_appview_screen）
>
> 4.提供 setuseInfo 设置用户信息（$identify）
>
> 5.每次提交数据中会携带系统信息 ： 屏幕宽、高，系统版本，小程序版本，设备型号，品牌，是否 wifi，设备 id（uuid 生成） 
>
> 6.元素曝光（$show_event），元素超过一半后，并且暴露时间超过 2s 进行记录，传入元素 id 即可
>
> 7.自定义事件：trackEvents 有需求可以直接用这个，实现自定义的事件
>
> 该项目会启动后会有一个唯一id进行本次整体记录，归纳为一次使用的记录，每50条进行一次上报，单次50条含以内会有一次唯一id进行记录，方便后台统计为一次
>
> 小程序切入后台后会进行1次上报，到达50条后会进行1次上报，每隔60s会进行一次数据的上报
>
> 如有需要进行源码修改即可

#### 软件架构

`javascript`
`uuid`
`wxmp-rsa`
`rollup`

#### 安装教程

> 装完记得构建😧

```shell
npm install burying-point-rice
```

#### 实现内容

本项目实现了一些静默事件，切换前后台记录事件，启动事件，页面时长浏览记录，元素曝光度等...
具体请看源码部分，这里依旧提供`自定义事件`，通过`trackEvents`发送即可

会记录浏览时长的自定义事件可以使用trackTime,trackTimeEnd

#### 使用说明

> `app.js` 引入,实例化并挂载微信
> 实例化传入后台创建的 `appid`,和上报的后台地址
>
> screenTime： 页面浏览超过n秒后开始记录，默认10s

```javascript
import buryingPonit from "burying-point-rice";
let base = {
  key: "",
  baseUrl: "",
  screenTime: 5
};
wx.byr = new buryingPonit(base);
App({});
```

页面 js 内调用方法

```javascript
page({
  onShow() {
    // 开始记录事件时间，后期可能修改为对象记录，为了实现同时进行多个事件记录
    wx.byr.trackTime();
  },
  onHide() {
    wx.byr.trackTimeEnd({
      event: "",
      last_page_code: "",
      data1: "",
      data2: "",
      ...val,
    });
  },
  handleTap() {
    wx.byr.setUserInfo();

    wx.byr.trackEvents({
      event: "",
      data2: "",
      ...val,
    });
  },
});
```

#### 项目中的一些方法使用

**自定义浏览事件(这里会静默记录此次事件时常)**

| 事件         | 参数                                       |
| ------------ | ------------------------------------------ |
| trackTime    | 无                                         |
| trackTimeEnd | object 对象（event:事件名 other:其他参数） |

**自定义点击事件**

| 事件        | 参数                                       |
| ----------- | ------------------------------------------ |
| trackEvents | object 对象（event:事件名 other:其他参数） |

**设置用户信息/distinct_id**

| 事件        | 参数        |
| ----------- | ----------- |
| setUserInfo | distinct_id |

**元素曝光度**

| 事件            | 参数                                                         |
| --------------- | ------------------------------------------------------------ |
| elementExposure | object对象:<br />rate：元素暴露比例0-1 <br />duration:停留时长,默认2s <br />ids:数组，元素唯一id不用传`#` <br />event：事件名，这边提供了默认的，可以不用） |