Mql-web-report NPM

koznak-report

大数据上报

安装

npm i mql-web-report -S

示例 🌰

import ReportSdk from "mql-web-report";
const reportSdk = ReportSdk.getReportSdk("appKey", {
  userId: "",
  version: "",
  tocken: "",
  deviceId: "",
  carrier: "",
});
// 心跳事件
reportSdk.reportHeart();
// 浏览事件
reportSdk.reportPage({
  pageId: "",
  pageName: "",
  eventId: "",
  eventType: "",
});

参数

字段	说明	类型	是否必穿、默认值
appKey	大数据唯一标识	string	✅
userInfo	用户信息	UserInfo	✅
env	环境	`"test \| "product"`	可为空、默认`"test"`测试环境

UserInfo

字段	说明	类型
userId	唯一标识	string
tocken	登陆令牌	string
version	版本号	string
deviceId	设备ID	string
carrier	运营商	"Mobile" ｜ "Unicom" ｜ "Telecom" ｜""

方法

reportHeart 🔧

心跳事件

代码演示

import ReportSdk from "mql-web-report";
const reportSdk = ReportSdk.getReportSdk("appKey", {
  userId: "",
  version: "",
  tocken: "",
  deviceId: "",
  carrier: "",
});
reportSdk.reportHeart();

返回类型

Promise<void>

reportPage 🔧

浏览事件

代码演示

import ReportSdk from "mql-web-report";
const reportSdk = ReportSdk.getReportSdk("appKey", {
  userId: "",
  version: "",
  tocken: "",
  deviceId: "",
  carrier: "",
});
reportSdk.reportPage({
  pageId: "",
  pageName: "",
  eventId: "",
  eventType: "",
});

参数说明

ReportPageP

字段	说明	类型	是否比传
pageId	页面ID	string	✅
pageName	页面名称	string	✅
eventId	事件ID	string	✅
eventType	事件类型	string	✅
dataMap	自定义数据	`{[key:string]:any}`	❌

返回类型

Promise<void>

reportClick 🔧

点击事件

代码演示

import ReportSdk from "mql-web-report";
const reportSdk = ReportSdk.getReportSdk("appKey", {
  userId: "",
  version: "",
  tocken: "",
  deviceId: "",
  carrier: "",
});
reportSdk.reportClick({
  pageId,
  targetId,
  targetName,
  targetType,
  eventId,
  eventType,
});

参数说明

ReportClickP

字段	说明	类型	是否比传
pageId	页面ID	string	✅
pageName	页面名称	string	✅
eventId	事件ID	string	✅
eventType	事件类型	string	✅
targetType	目标类型	string	✅
targetName	目标类型	string	✅
dataMap	自定义数据	`{[key:string]:any}`	❌

返回类型

Promise<void>

reportExposure 🔧

曝光事件

代码演示

import ReportSdk from "mql-web-report";
const reportSdk = ReportSdk.getReportSdk("appKey", {
  userId: "",
  version: "",
  tocken: "",
  deviceId: "",
  carrier: "",
});
reportSdk.reportExposure({
  pageId,
  targetId,
  targetName,
  targetType,
  eventId,
  eventType,
});

参数说明

ReportExposureP

字段	说明	类型	是否比传
pageId	页面ID	string	✅
pageName	页面名称	string	✅
eventId	事件ID	string	✅
eventType	事件类型	string	✅
targetType	目标类型	string	✅
targetName	目标类型	string	✅
dataMap	自定义数据	`{[key:string]:any}`	❌

返回类型

Promise<void>

类型定义

import type {
  Sdk,
  Env,
  ReportClickP,
  ReportExposureP,
  ReportPageP,
  DataMap,
  Target,
  Event,
  Page,
  UserInfo,
} from "mql-web-report";