คู่มือการผสานรวม Web SDK

เอกสารนี้เป็นคู่มือการผสานรวมมาตรฐานสำหรับ MA Web SDK

การเตรียมตัวก่อนการผสานรวม

เพื่อใช้บริการ EngageLab MA คุณจำเป็นต้องผสานรวมโมดูล WebPush ก่อน
เตรียมชื่อโดเมนบริการเว็บ HTTPS ที่สามารถเข้าถึงได้ หลังจากการผสานรวมแล้ว จำเป็นต้องทดสอบและดีบักหน้าเว็บภายใต้ชื่อโดเมนนี้ การแจ้งเตือนแบบพุชออฟไลน์บนเว็บไม่รองรับการดีบักในเครื่องและ HTTP
เข้าถึง EngageLab WebPush และในหน้า [การตั้งค่าการผสานรวม] - [ชื่อโดเมนเว็บไซต์] ให้กรอกชื่อโดเมนบริการเว็บ HTTPS

Screenshot 2022-11-29 11.08.16.png

คำอธิบายผลิตภัณฑ์

โมดูล MA ใน EngageLab Web SDK ให้บริการฟังก์ชันการรวบรวมและรายงานข้อมูล ซึ่งใช้ในสถานการณ์ต่าง ๆ เช่น การสร้าง EUID การตั้งค่าคุณสมบัติของผู้ใช้ และการรายงานเหตุการณ์

สถานการณ์หลัก:

ตั้งค่าคุณสมบัติหลากหลายประเภทและรายงานเหตุการณ์หลากหลายประเภท

รับข้อมูลแอปพลิเคชัน

คุณจำเป็นต้องสร้างแอปพลิเคชันในคอนโซล WebPush หลังจากสร้างสำเร็จแล้ว จะมีการสร้าง AppKey โดยอัตโนมัติเพื่อระบุแอปพลิเคชันนี้ สำหรับรายละเอียดเพิ่มเติม โปรดดูที่ เอกสารการตั้งค่าแอปพลิเคชัน

การเข้าถึง SDK

ไปที่ คอนโซล ดาวน์โหลด SDK และเข้าถึง JavaScript ในแต่ละหน้า:

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

โค้ดนี้โชว์เป็นหน้าต่างลอย

เคล็ดลับ

หลังจากนำเข้า JavaScript นี้ ให้ส่งคุณสมบัติ maOpen พร้อมค่าที่เป็น true เพื่อเปิดใช้งานการตั้งค่า MA และจากนั้นคุณสามารถใช้ API และฟังก์ชันที่เกี่ยวข้องของ MA ได้

การเริ่มต้น 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);
        }
  }
});

โค้ดนี้โชว์เป็นหน้าต่างลอย

API เพิ่มเติม

สำหรับการใช้งาน API อื่น ๆ โปรดดูเอกสารอินเทอร์เฟซ: Web SDK API