คู่มือ SDK API

ตั้งค่ารหัสผู้ใช้

การกำหนดอินเทอร์เฟซ

• identifyAccount(user);
  • คำอธิบายอินเทอร์เฟซ：
    • ตั้งค่ารหัสผู้ใช้ เช่น หมายเลขบัตรสมาชิกของผู้ใช้
  • คำอธิบายพารามิเตอร์
    • identity: รหัสประจำตัวผู้ใช้
    • completion: การเรียกกลับ

ตัวอย่างการเรียกใช้

              
                  let user = {completion: (code, message) => {}, identity: {"id": "value"}}
    window.MAInterface.identifyAccount(user)

            

รับ EUID

การกำหนดอินเทอร์เฟซ

• + EUID()
  • คำอธิบายอินเทอร์เฟซ：
    • รับ EUID ของ EngageLab MA

ตัวอย่างการเรียกใช้

              
                  window.MAInterface.EUID((code, euid) => {
        console.log(code, euid)
    })

            

ตั้งค่าข้อมูลติดต่อผู้ใช้

การกำหนดอินเทอร์เฟซ

• setUserContact(user)
  • คำอธิบายอินเทอร์เฟซ：
    • รองรับการตั้งค่าค่าข้อมูลติดต่อหลายประเภทพร้อมกัน Key คือชื่อข้อมูลติดต่อ Value คือค่าของข้อมูลติดต่อ ปัจจุบันรองรับข้อมูลติดต่อ 4 ประเภท: email, mobile_phone, landline_phone และ whatsapp_phone
  • คำอธิบายพารามิเตอร์
    • contacts: ข้อมูลติดต่อของผู้ใช้
    • completion: การเรียกกลับ

ตัวอย่างการเรียกใช้

              
                    let user = {
          completion: (code, message) => { },
          contacts: {}
       }
      user.contacts["ชื่อข้อมูลติดต่อ"] = "ค่าของข้อมูลติดต่อ"   // เช่น：mobile_phone = 18800000000
      window.MAInterface.setUserContact(user)

            

ตั้งค่าคุณสมบัติ UTM

การกำหนดอินเทอร์เฟซ

• setUtmProperties(attrs:any)
  • คำอธิบายอินเทอร์เฟซ：
    • คุณสมบัติ UTM เป็นคุณสมบัติมาตรฐานของเหตุการณ์ หากนักพัฒนาสามารถระบุได้ว่าผู้ใช้มาจากโฆษณาใดเมื่อเข้าสู่แอป ขอแนะนำให้ตั้งค่าข้อมูล UTM เราจะส่งพารามิเตอร์นี้เมื่อรายงานเหตุการณ์ ปัจจุบันสามารถตั้งค่าคุณสมบัติ UTM ได้ดังนี้:
      • utm_source: แหล่งที่มาของแคมเปญโฆษณา
      • utm_medium: สื่อของแคมเปญโฆษณา
      • utm_term: คำหลักของแคมเปญโฆษณา
      • utm_content: เนื้อหาของแคมเปญโฆษณา
      • utm_campaign: ชื่อของแคมเปญโฆษณา
      • utm_id: ID ของแคมเปญโฆษณา

ตัวอย่างการเรียกใช้

              
                 window.MAInterface.setUtmProperties({"utm_source": "value1"})

            

ตั้งค่าคุณสมบัติผู้ใช้

ตั้งค่าค่าคุณสมบัติของผู้ใช้ หากคุณสมบัติของผู้ใช้ไม่มีอยู่ ระบบจะสร้างขึ้นโดยอัตโนมัติ

เขียนทับและอัปเดตคุณสมบัติผู้ใช้

• setProperty(user, completion)
  • คำอธิบายอินเทอร์เฟซ：
    • เขียนทับและอัปเดตค่าคุณสมบัติของผู้ใช้
    • บันทึกเฉพาะข้อมูลล่าสุดที่รายงาน เขียนทับข้อมูลในอดีต เช่น ระดับสมาชิกของผู้ใช้
    • เนื้อหาคุณสมบัติของผู้ใช้เหล่านี้ถูกเก็บไว้ในออบเจ็กต์หนึ่ง โดย Key เป็นชื่อคุณสมบัติของผู้ใช้และต้องเป็นสตริง Value เป็นเนื้อหาคุณสมบัติของผู้ใช้ รองรับเฉพาะ string, number และ Array
    • ปัจจุบัน ค่าประเภท Array รองรับเฉพาะองค์ประกอบที่เป็นสตริง
    • หากคุณสมบัติของผู้ใช้มีอยู่ก่อนหน้านี้ จะถูกเขียนทับในครั้งนี้ หากไม่มี จะถูกสร้างขึ้น
  • ตัวอย่างการเรียกใช้：

              
                 window.MAInterface.setProperty({key: "value"}, (code, message) => {})

            

อัปเดตคุณสมบัติผู้ใช้แบบเพิ่มค่า

• increaseProperty(user, completion)
  • คำอธิบายอินเทอร์เฟซ：
    • ตั้งค่าการเพิ่มค่าสำหรับคุณสมบัติของผู้ใช้
    • เพิ่มค่าของคุณสมบัติผู้ใช้ที่เป็นตัวเลขหลายรายการ รวมค่าทั้งหมดที่รายงาน เช่น ยอดการใช้จ่ายสะสม
    • อินเทอร์เฟซนี้สามารถเรียกใช้ได้เฉพาะคุณสมบัติผู้ใช้ที่เป็นตัวเลขเท่านั้น หากคุณสมบัติผู้ใช้ไม่มีอยู่ก่อนหน้านี้ ค่าตั้งต้นจะถือว่าเป็น 0
  • ตัวอย่างการเรียกใช้：

              
               window.MAInterface.increaseProperty({key: 1}, (code, message) => {})

            

เพิ่มค่าคุณสมบัติผู้ใช้

• addProperty(key, content completion)
  • คำอธิบายอินเทอร์เฟซ：
    • เพิ่มค่าคุณสมบัติของผู้ใช้
    • เพิ่มองค์ประกอบในชุดข้อมูลนี้อย่างต่อเนื่อง เมื่อเก็บลงฐานข้อมูลจะลบค่าที่ซ้ำกัน หากมีค่า ABC อยู่แล้ว เพิ่ม CD ผลลัพธ์สุดท้ายจะเป็น ABCD เช่น ข่าวที่ผู้ใช้กดถูกใจ
    • เพิ่มค่าบางอย่างให้กับคุณสมบัติประเภท Array องค์ประกอบใน Array ต้องเป็นสตริงเท่านั้น มิฉะนั้นจะถูกละเว้น และหากคุณสมบัติผู้ใช้ที่ต้องการเพิ่มไม่มีอยู่ก่อนหน้านี้ จะถูกตั้งค่าเริ่มต้นเป็น Array ว่างเปล่า
  • ตัวอย่างการเรียกใช้：

              
               window.MAInterface.addProperty("key", ["value1", "value2"], (code, message) => {})

            

ลบค่าคุณสมบัติผู้ใช้

• removeProperty(key, content completion)
  • คำอธิบายอินเทอร์เฟซ：
    • ลบค่าหนึ่งหรือหลายค่าจากคุณสมบัติประเภท Array
    • ลบบางค่าจากคุณสมบัติประเภท Array องค์ประกอบใน Array ต้องเป็นสตริงเท่านั้น มิฉะนั้นจะถูกละเว้น และหากคุณสมบัติผู้ใช้ที่ต้องการลบไม่มีอยู่ก่อนหน้านี้ จะไม่มีผลกระทบใดๆ
  • ตัวอย่างการเรียกใช้：

              
               window.MAInterface.removeProperty("key", ["value1", "value2"], (code, message) => {})

            

ลบคุณสมบัติผู้ใช้

การกำหนดอินเทอร์เฟซ

• deleteProperty(key, completion)
  • คำอธิบายอินเทอร์เฟซ：
    • ลบค่าทั้งหมดของคุณสมบัติผู้ใช้
    • หากคุณสมบัติผู้ใช้ไม่มีอยู่ก่อนหน้านี้ จะถูกละเว้นโดยตรง

ตัวอย่างการเรียกใช้

              
               window.MAInterface.deleteProperty("key", (code, message) => {})

            

ตั้งค่าเวลาหมดอายุของเซสชัน

การกำหนดอินเทอร์เฟซ

• setSessionTimeout(time)
  • คำอธิบายอินเทอร์เฟซ：
    • ตั้งค่าเวลาหมดอายุของเซสชัน เมื่อหน้าเว็บถูกย้ายไปยังพื้นหลัง เวลาหมดอายุของเซสชันจะเริ่มนับ หากเกินเวลาที่กำหนด (ค่าเริ่มต้น 30 นาที) เซสชันนั้นจะสิ้นสุด

ตัวอย่างการเรียกใช้

              
               window.MAInterface.setSessionTimeout(60)

            

ตั้งค่าเวลาที่อยู่ในหน้าเว็บ

การกำหนดอินเทอร์เฟซ

• setPageStayTime(time)
  • คำอธิบายอินเทอร์เฟซ：
    • ตั้งค่าระยะเวลาที่อยู่ในหน้าเว็บ
    • เริ่มนับเวลาหลังจากเข้าสู่หน้าเว็บ หากผู้ใช้ยังอยู่ในหน้าเว็บเป็นเวลา time วินาทีโดยไม่ออก จะรายงานเหตุการณ์นั้น
    • โดยค่าเริ่มต้นจะรายงานใน 6 ช่วงเวลา: 5 วินาที, 30 วินาที, 60 วินาที, 2 นาที, 5 นาที และ 10 นาที นักพัฒนาสามารถเรียกใช้อินเทอร์เฟซนี้เพื่อเพิ่มช่วงเวลาเพิ่มเติมได้

ตัวอย่างการเรียกใช้

              
               window.MAInterface.setPageStayTime(60)

            

รายงานเหตุการณ์

หากเหตุการณ์ไม่มีอยู่ จะรายงานโดยตรง ระบบจะสร้างเหตุการณ์นั้นโดยอัตโนมัติ

การกำหนดอินเทอร์เฟซ

• onEvent(event)
  • คำอธิบายอินเทอร์เฟซ：
    • รายงานเหตุการณ์
  • คำอธิบายพารามิเตอร์
    • event: เหตุการณ์ที่ต้องการรายงาน name คือชื่อเหตุการณ์ properties คือข้อมูลคุณสมบัติของเหตุการณ์ ซึ่ง Key คือชื่อคุณสมบัติ Value คือค่าคุณสมบัติ

ตัวอย่างการเรียกใช้

              
                 let event = {name: "name", properties: {key: "value"}}
    window.MAInterface.onEvent(event)