visual-buried-point-platform-uni 1.0.0-alpha → 1.0.0-alpha.2

package/README.md

@@ -1,93 +1,196 @@
-# 可视化埋点uni端
+## Uni版自定义埋点SDK集成文档
 
+### 1、引入方式
 
+```js
+npm install visual-buried-point-platform-uni -S --registry=http://verdaccio.gogdev.cn/
+工具-构建npm
+```
 
-## Getting started
+### 2、初始化方式
+
+**app.js**
+
+```js
+//require引入
+import { init } from 'visual-buried-point-platform-uni'
+onLaunch: function() {
+      //初始化sdk
+      init({
+        env: 'test', //环境变量 test production
+        token: '3212414516342554624', //热果平台-可视化埋点管理端-创建对应的项目生成. 
+        sourceDomain: 'com.gzdzswy.onetravel', // 非必填，访问来源域名，取优先级：单次调用上报值 > 全局初始化值
+      })
+    }
+});
+```
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+ ### 3、设置绑定用户ID
 
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+- sdk初始化后，可通过 ***setUserId()*** 方法关联用户，sdk会默认生成一个游客ID
 
-## Add your files
+```js
+// 应用在注册或登录成功后，可调用下面API设置用户ID，后续产生的统计事件将会与该用户关联起来
+setUserId("登录成功-用户ID")
+```
 
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+**示例：**
 
+```js
+import { setUserId } from 'visual-buried-point-platform-uni'
+setUserId(123456);
 ```
-cd existing_repo
-git remote add origin http://10.10.11.151:20216/teg/bigdata-center/buried-point/front-end/visual-buried-point-platform-uni.git
-git branch -M main
-git push -uf origin main
+
+**注：为保持数据统计精确，在退出登录的时候建议调用一次清空：**
+
+```js
+setUserId("");
 ```
 
-## Integrate with your tools
 
-- [ ] [Set up project integrations](http://10.10.11.151:20216/teg/bigdata-center/buried-point/front-end/visual-buried-point-platform-uni/-/settings/integrations)
 
-## Collaborate with your team
+### 4、自定义事件上报
 
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
+- sdk初始化后，可通过 ***setCustomEvent()*** 方法上报自定义埋点事件，并为事件添加属性值：
 
-## Test and Deploy
+#### 4.1 事件类型：
 
-Use the built-in continuous integration in GitLab.
+- 仅能选择埋点提供的事件类型，各事件类型的触发、上报由各业务平台埋点自行确认。事件类型如下：
+- **搜索事件【 search 】**
+- **动作事件【 action 】**
+- **点击事件【 click 】**
+- **浏览事件【 browse 】**
 
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+```js
+// 调用自定义上报
+setCustomEvent(data)
+```
 
-***
+**配置：**
 
-# Editing this README
+| 参数          | 必填 | 描述                           |
+| ------------- | ---- | ------------------------------ |
+| $event_id     | 是   | 对应创建的事件ID 【图2】       |
+| $extend_param | 否   | 扩展字段，建议根据业务需求填上 |
+| $busSegment   | 否   | 业务板块 【表1】各自业务板块   |
+| $module       | 否   | 业务模块【表1】各自业务模块    |
 
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
+表1
 
-## Suggestions for a good README
+```js
+示例如下：
+业务板块        业务模块
+busSegment     module
+1.景区/门票   1.门票
+2.民宿/酒店   1.民宿 2.酒店
+```
 
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+**示例：**
+
+
+```js
+// 注：
+data: JSON字符串
+{
+    $event_id: 对应创建的事件ID 【必填字段】
+    $extend_param: 扩展参数(JSON字符串) 【非必填字段，建议根据业务需求填上】
+    $busSegment: 业务板块 【非必填字段，建议业务填上, 否则数据统计可能出现缺失】
+    $module: 业务模块 【非必填字段，建议根据业务填上， 否则数据统计可能出现缺失】
+    $ctk: 渠道推广编码 【非必填字段，建议根据业务填上， 否则数据统计可能出现缺失】
+    $duration: 停留时长 【非必填字段】
+    $event_code: 事件标识符 【必填字段，建议根据业务填上， 否则数据统计可能出现缺失】
+    $page: 当前页对象 【非必填字段，建议根据业务填上， 否则数据统计可能出现缺失】
+    $path: 埋点组件的路径 【必填字段，建议根据业务填上， 否则数据统计可能出现缺失】
+}
+// 参考：【点击事件】
+const params = {
+    $event_id: "3213106620739878912",
+    $busSegment: 1,
+    $module: 1, 
+    $ctk: "",
+    $extend_param: { 
+        title: "自定义[点击事件]上报-点击_密码登录按钮", 
+        clickContent: "密码登录",
+      ....
+      ....
+    },
+    $event_code: "",
+    $page: {
+      domain: "",
+      path: "",
+      title: "",
+    },
+    $path: "",
+}
+setCustomEvent(params)
+```
 
-## Name
-Choose a self-explaining name for your project.
+### 5、流量上报
+
+- sdk初始化后，可通过**onStartTrack(params)** 方法注册上报流量，并为上报添加属性值：
+
+**注册上报流量：onStartTrack(params)**
+
+**配置：**【以下配置参数建议上报】
+
+| 参数         | 必填 | 类型                | 描述             |
+| ------------ | ---- | ------------------- | ---------------- |
+| domain       | 是   | string              | 域名             |
+| path         | 是   | string              | 路径             |
+| circulation  | 否   | number              | 页面访问类型     |
+| ctk          | 否   | string              | 渠道推广编码     |
+| duration     | 否   | number              | 停留时长         |
+| busSegment   | 否   | string              | 业务板块 【表1】 |
+| module       | 否   | string              | 业务模块 【表1】 |
+| extend_param | 否   | JSON对象 {}         | 扩展参数         |
+| sourceDomain | 否   | string              | 访问来源域名     |
+| sourceUrl    | 否   | string              | 访问来源url      |
+| title        | 否   | string              | 页面名称         |
+| traceId      | 否   | string              | 追踪id           |
+| visitPage    | 否   | number              | 访问深度         |
+| visitTime    | 否   | yyyy-MM-dd HH:mm:ss | 访问时间         |
+
+**示例：**
+
+```js
+// 注：
+data: JSON对象
+const params = {
+  domain: "xxxx",
+  busSegment: 1,
+  module: 1,
+  title: "店铺详情",
+  sourceDomain: 'com.gzdzswy.onetravel',
+  extend_param: {
+      goods_id: 123456, //商品id 【根据业务确定】
+      store_id: 1111, //店铺id   【...】
+      business_id: 222, //商户id 【...】
+  }
+};
+onStartTrack(params)
+```
 
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+**销毁上报流量：调用onDestroyTrack()进行销毁**
 
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+**示例：**
+
+```js
+onDestroyTrack()
+```
 
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+注： 上报数据是否成功可查看NetWork栏，调用流量上报 **track 接口** 和 自定义上报 **event 接口**的 response
 
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+#### 6、埋点后台管理系统
 
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+##### 云测管理端地址
 
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+- chameleon.gcongo.com.cn
 
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+#### 7、SDK 文档
 
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
+http://verdaccio.gogdev.cn/-/web/detail/visual-buried-point-platform-uni
 
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
 
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
 
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
 
-## License
-For open source projects, say how it is licensed.
 
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

package/index.js

@@ -43,7 +43,6 @@ export function init(config) {
     let _cf = setReportUrl(config.env ? config.env : "");
     reportUrl = _cf.reportUrl;
     reportTrackUrl = _cf.reportTrackUrl;
-    eventListUrl = _cf.eventListUrl;
     if (config.flushInterval) {
       if (config.flushInterval < 5) {
         config.flushInterval = 15;
@@ -75,14 +74,14 @@ export function init(config) {
   startGlobalTime();
 }
 
-//the general custom report interval is enabled
+//the general custom reportCustom interval is enabled
 function startGlobalTime() {
   clearInterval(cInterval);
   cInterval = setInterval(() => {
     let cData = getSData();
-    console.log("storage data " + cData);
+    console.log("storage data " + JSON.stringify(cData));
     if (cData) {
-      report(cData);
+      reportCustom(cData);
       delSData();
     }
   }, _config.flushInterval * 1000);
@@ -130,13 +129,14 @@ export function setCustomEvent(data) {
     addCache(reportData);
     const data = getCache();
     if (data.length) {
+      console.log("customData: ", JSON.stringify(data));
       addSData(data);
       clearCache();
     }
   }
 }
 
-function report(data) {
+function reportCustom(data) {
   if (!reportUrl) {
     //console.error("please set upload data url");
     return;
@@ -146,21 +146,19 @@ function report(data) {
     ...comData,
     dataAbstract: MD5(JSON.stringify(comData)),
   };
-  uni.nextTick(function () {
-    uni.request({
-      url: reportUrl,
-      method: "POST",
-      header: {
-        "Content-Type": "application/json",
-        appKey: _config.token,
-        projectId: _config.token,
-      },
-      data: reportData,
-      success: function (res) {},
-      fail: function (error) {
-        console.error(error);
-      },
-    });
+  uni.request({
+    url: reportUrl,
+    method: "POST",
+    header: {
+      "Content-Type": "application/json",
+      appKey: _config.token,
+      projectId: _config.token,
+    },
+    data: reportData,
+    success: function (res) {},
+    fail: function (error) {
+      console.error(error);
+    },
   });
 }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "visual-buried-point-platform-uni",
-  "version": "1.0.0-alpha",
-  "lsi": "e640f6dcca0160bfded7c074ba108e9f",
+  "version": "1.0.0-alpha.02",
+  "lsi": "f0ca171a9f641657370a83f2f7ed65c7",
   "description": "To make it easy for you to get started with GitLab, here's a list of recommended next steps.",
   "main": "index.js",
   "scripts": {

package/tools.js

@@ -168,9 +168,9 @@ export function getTrackObj(busObj) {
   const pages = getCurrentPages();
   const gcp = pages[pages.length - 1];
   //h5
-  let wl = window.location;
-  let docTitle = document.title;
-  let refurl = document.referrer;
+  // let wl = window.location;
+  // let docTitle = document.title;
+  // let refurl = document.referrer;
   let parsedUrl;
   if (refurl) {
     parsedUrl = new URL(refurl);
@@ -183,22 +183,10 @@ export function getTrackObj(busObj) {
     }
   }
   if (gcp) {
-    let domain = "";
-    let url = "";
-    if (busObj.domain) {
-      domain = busObj.domain;
-    } else {
-      domain = wl.hostname ? wl.hostname : "";
-    }
-    if (busObj.url) {
-      url = busObj.url;
-    } else {
-      url = wl.href ? wl.href : "";
-    }
     return {
       path: gcp.route,
-      domain: domain,
-      url: url,
+      domain: busObj.domain ? busObj.domain : "",
+      url: busObj.url ? busObj.url : "",
       circulation: gcp.length > 1 ? 2 : 1,
       visitPage: gcp.length,
       sourceDomain: parsedUrl ? parsedUrl.hostname : "",