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="./webPushSdk.min.3.0.0.js"></script>

此代碼塊在浮窗中顯示

tips

引入該js後，傳入maOpen為true屬性開啟MA配置，就可以使用MA的相關API和功能。

SDK初始化

// 初始化（開啟MA） MTpushInterface.init({ appkey: "", // 必填，詳見上文獲取應用資訊 user_str: "adminDemo", // 必填，使用者識別符，用來標識使用者 swUrl: "url", // 預設 "/sw.min." + sdkEnv.version + ".js"。該配置項為server worker檔案位址，域名必須為當前域名，且路徑決定server worker作用域。 debugMode: true,// 設定是否開啟 debug 模式。true 則會列印更多的日誌資訊。設定 false 則只會輸出 w、e 級別的日誌。 channel: "default-channel",// 渠道名稱，預設值為:default-channel appName: "string",// 用於設定網站名稱，用於上報 maOpen: true, // 打開開關，開啟使用 MA 功能 userIdentity: { userId: "1234567890", anonymousId: "anonymous123" },// 在初始化MA的同時設定使用者標識，從 3.3.4 版本開始支援，適用於僅面向登入會員提供MA服務的企業 maCompletion: (code, msg) => {// MA初始化回調 if (code === 0) { console.log("✅MA SDK 初始化成功！"); } else { console.error("❌MA SDK 初始化失敗：", msg); } } });

              
              // 初始化（開啟MA）
MTpushInterface.init({
  appkey: "", // 必填，詳見上文獲取應用資訊
  user_str: "adminDemo", // 必填，使用者識別符，用來標識使用者
  swUrl: "url", // 預設 "/sw.min." + sdkEnv.version + ".js"。該配置項為server worker檔案位址，域名必須為當前域名，且路徑決定server worker作用域。
  debugMode: true,// 設定是否開啟 debug 模式。true 則會列印更多的日誌資訊。設定 false 則只會輸出 w、e 級別的日誌。
  channel: "default-channel",// 渠道名稱，預設值為:default-channel
  appName: "string",// 用於設定網站名稱，用於上報
  maOpen: true, // 打開開關，開啟使用 MA 功能
  userIdentity: { userId: "1234567890", anonymousId: "anonymous123" },// 在初始化MA的同時設定使用者標識，從 3.3.4 版本開始支援，適用於僅面向登入會員提供MA服務的企業
  maCompletion: (code, msg) => {// MA初始化回調
        if (code === 0) {
          console.log("✅MA SDK 初始化成功！");
        } else {
          console.error("❌MA SDK 初始化失敗：", msg);
        }
  }
});