Web SDK 集成指南

本文是 MA Web SDK 标准的集成指南文档。

集成前准备

使用 EngageLab MA 服务需要同时集成 WebPush 模块
准备一个能访问的 https web 服务域名，集成后的页面需在该域名下进行测试与调试。web 离线推送不支持本地调试、不支持 http。
访问 Engagelab WebPush，在【集成设定】-【网站域名】页面，填写 https web 服务域名。

截屏2022-11-29 11.08.16.png

产品说明

EngageLab Web SDK 中的 MA 模块提供数据采集上报功能，用于 EUID 生成、用户属性设置、事件上报等场景

主要场景：

设置各种类型的属性，上报各种类型的事件

获取应用信息

需要在 WebPush 控制台上创建应用，创建成功后自动生成 AppKey 用以标识该应用，详情参考应用设置文档。

SDK 接入

进入控制台，下载 SDK，在每个页面接入 js：

          <script type="text/javascript" src="./WebSDK.3.0.0.js"></script>

此代码块在浮窗中显示

tips

引入该 js 后，传入 maOpen 为 true 属性开启 MA 配置，就可以使用 MA 的相关 API 和功能

SDK 初始化

// 初始化（开启MA） MTpushInterface.init({ appkey: "", // 必填，详见上文获取应用信息 user_str: "adminDemo", // 必填，用户识别符，用来标识用户 swUrl: '', //默认 "/sw.min." + sdkEnv.version + ".js"。该配置项为server worker文件地址，域名必须为当前域名，且路径决定server worker作用域。 maOpen: true, //打开开关，开启使用 MA 功能 debugMode: boolean;// 设置是否开启 debug 模式。true 则会打印更多的日志信息。设置 false 则只会输出 w、e 级别的日志。 channel: string;// 渠道名称，默认值为:default-channel appName: string;// 用于设置网站名称，用于上报 });

              //  初始化（开启MA）
  MTpushInterface.init({
    appkey: "", // 必填，详见上文获取应用信息
    user_str: "adminDemo", // 必填，用户识别符，用来标识用户
    swUrl: '', //默认 "/sw.min." + sdkEnv.version + ".js"。该配置项为server worker文件地址，域名必须为当前域名，且路径决定server worker作用域。
    maOpen: true, //打开开关，开启使用 MA 功能
    debugMode: boolean;// 设置是否开启 debug 模式。true 则会打印更多的日志信息。设置 false 则只会输出 w、e 级别的日志。
    channel: string;// 渠道名称，默认值为:default-channel
    appName: string;// 用于设置网站名称，用于上报
  });