API指引

設置用戶標識

接口定義

• identifyAccount(user);
  • 接口說明:
    • 設置用戶標識，如：用戶會員卡號。
  • 參數說明
    • identity用戶標識ID
    • completion回調

調用示例

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

        

獲取 EUID

接口定義

• + EUID()
  • 接口說明:
    • 獲取EngageLab MA的EUID

調用示例

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

        

設置用戶聯繫方式

接口定義

• setUserContact(user)
  • 接口說明:
    • 支援同時設置多個聯繫方式的值。，Key為聯繫方式的名稱，value為聯繫方式的值，目前支援email、mobile_phone、landline_phone、whatsapp_phone這4種聯繫方式
  • 參數說明
    • contacts用戶聯繫方式
    • completion回調

調用示例

                let user = {
          completion: (code, message)=>{ },
          contacts: {}
       }
      user.contacts["聯繫方式的名稱"] = "聯繫方式的值"   //例如：mobile_phone=18800000000
      window.MAInterface.setUserContact(user)

        

設置 UTM 屬性

接口定義

• setUtmProperties(attrs:any)
  • 接口說明:
    • UTM屬性為標準事件屬性，若開發者能識別用戶是從哪一個廣告跳轉訪問App，建議設置UTM信息，我們將在事件上報時傳遞該參數。目前能夠設置UTM屬性為：
      • utm_source廣告系列來源
      • utm_medium廣告系列媒介
      • utm_term廣告系列字詞
      • utm_content廣告系列內容
      • utm_campaign廣告系列名稱
      • utm_id廣告系列ID

調用示例

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

        

設置用戶屬性

設置用戶屬性的值，若用戶屬性不存在，後台會自動創建。

覆蓋更新用戶屬性

• setProperty(user, completion)
  • 接口說明:
    • 覆蓋更新用戶屬性的值
    • 僅保存最新上報的數據，覆蓋歷史數據，如：用戶會員等級。
    • 這些用戶屬性的內容用一個object來存儲，其中的key是用戶屬性的名稱，必須是string，Value則是用戶屬性的內容，只支援string、number，Array這些類型。
    • Array類型的value中目前只支援其中的元素是string。
    • 如果某個用戶屬性之前已經存在了，則這次會被覆蓋掉；不存在，則會創建。
  • 調用示例:

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

        

累加更新用戶屬性

• increaseProperty(user, completion)
  • 接口說明:
    • 對用戶屬性的值設置累加。
    • 給多個數值類型的用戶屬性增加數值。累加所有上報的數據，如累計消費金額。
    • 只能對number類型的用戶屬性調用這個接口，否則會被忽略, 如果這個用戶屬性之前不存在，則初始值當做0來處理。
  • 調用示例：

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

        

追加用戶屬性

• addProperty(key, content completion)
  • 接口說明:
    • 對用戶屬性的值進行追加。
    • 可持續增加該集合元素，元素入庫去重處理，若已存在ABC，追加CD，最終為ABCD，如用戶點讚的新聞。
    • 向一個Array類型的屬性添加一些值，這個Array的元素必須是string，否則，會忽略, 同時，如果要append的用戶屬性之前不存在，會初始化一個空的Array。
  • 調用示例：

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

        

移除用戶屬性

• removeProperty(key, content completion)
  • 接口說明:
    • 刪除數組類型的屬性其中的一個或多個值。
    • 刪除一個Array類型的屬性中的一些值，這個Array的元素必須是string，否則，會忽略, 同時，如果要removeEventListAttrValue的用戶屬性之前不存在，則不會有效果。
  • 調用示例：

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

        

刪除用戶屬性

接口定義

• deleteProperty(key, completion)
  • 接口說明:
    • 刪除某個用戶屬性的全部value內容。
    • 如果這個用戶屬性之前不存在，則直接忽略。

調用示例

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

        

設置會話超時時間

接口定義

• setSessionTimeout(time)
  • 接口說明:
    • 設置會話超時時間，頁面置於後台時，開始計算會話超時時間，超過所設置的時間（默認30分鐘）後將會結束本次會話。

調用示例

           window.MAInterface.setSessionTimeout(60)

        

設置頁面停留時間

接口定義

• setPageStayTime(time)
  • 接口說明:
    • 設置頁面停留時間的持續時間。
    • 訪問頁面後開始計時，在該頁面停留time秒沒有跳走則上報該事件。
    • 默認在5秒、30秒、60秒、2分鐘、5分鐘、10分鐘這6個時間點上報，開發者可以調用本接口增加更多的時間點

調用示例

           window.MAInterface.setPageStayTime(60)

        

上報事件

如果事件不存在時直接上報，後台會自動創建該事件

接口定義

• onEvent(event)
  • 接口說明:
    • 上報事件
  • 參數說明
    • event上報的事件，name為事件名稱，properties為事件屬性信息，其中Key為屬性名稱，value為屬性值

調用示例

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