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)