跳到主要内容

WebSDK 玩法

最后更新：2024/03/20

移动端加载活动URL​

在调用活动URL方法前需要先进行'初始化SDK'

const params = {
  "url": "TurboLink Dashboard后台的活动URL，直接赋值就好", 
  "newWindow": "是否新窗口打开，默认：false",
}
Turbolink.loadUrl(params).then((result) => {
  console.log(result)
})
参数说明类型必需默认值
urlTurboLink Dashboard后台的活动URL，直接赋值就好string是无
newWindow是否新窗口打开，默认：falsebool否false

PC端加载活动URL​

在调用活动URL方法前需要先进行'初始化SDK'

const turbolinkEvenCallback = (event) => {
    console.log(event)
    const type = event?.type || ""
    switch (type) {
      case "linkLoginListener":
        console.log("触发了登录")
        break;
      case "linkEventListener":
        console.log("触发了去完成任务")
        console.log(event?.params)
        break;
      case "linkRedirectListener":
        console.log("触发了奖品去使用")
        console.log(event?.params)
        break;
      case "linkPointsListener":
        console.log("触发了点击区域埋点")
        console.log(event?.params)
        break;
      case "linkCloseListener":
        console.log("用户主动点击关闭")
        break;
    }
}


const params = {
  "url": "TurboLink Dashboard后台的活动URL，直接赋值就好", 
  "maskColor": "弹出层背景色，默认：rgba(0, 0, 0, 0.8)",
  "zIndex": "弹出层z-index，默认：3000",
  "backgroundImage": "背景图地址，默认：创建活动上传的图",
  "backgroundWidth": "背景图宽度，默认：auto",
  "backgroundHeight": "背景图高度，默认：738px",
  "width": "玩法窗口宽度，默认：300px",
  "height": "玩法窗口高度，默认：650px",
  "bgLinkage": "设置玩法窗口高宽时背景图是否联动变化，默认：false",
  "radius": "玩法窗口圆角，默认：12px",
  "bodyHidden": "窗口打开后是否禁止页面滑动，默认：true",
  "jumpNewWindow": "玩法内页面跳转时是否新标签页打开页面，默认：false（当前页打开）"
  "clickEventCallback": turbolinkEvenCallback // "玩法内监听方法点击回调，如：登录、去完成任务等"，
}

Turbolink.webLoadUrl(params).then((result) => {
  console.log(result)
})
参数说明类型必需默认值
urlTurboLink Dashboard后台的活动URL，直接赋值就好string是无
maskColor弹出层背景色string否rgba(0, 0, 0, 0.8)
zIndex弹出层z-indexnumber否3000
backgroundImage背景图地址string否创建活动上传的图
backgroundWidth背景图宽度number否auto
backgroundHeight背景图高度number否738px
width玩法窗口宽度number否300px
height玩法窗口高度number否650px
bgLinkage设置玩法窗口高宽时背景图是否联动变化boolean否false
radius玩法窗口圆角number否12px
bodyHidden窗口打开后是否禁止页面滑动boolean否true
jumpNewWindow玩法内页面跳转时是否新标签页打开页面boolean否false（当前页打开）
clickEventCallback请查看玩法内监听方法回调数据说明WebClickCallParam否无

WebClickCallParam：玩法内监听方法回调数据说明​

字段说明类型必需默认值
type监听类型：请查看玩法内监听类型说明string是无
params数据：json字符串需要调用JSON.parse(params)转换；任务事件数据类型： 查看；去使用奖品数据类型： 查看；点击区域埋点：查看string否无

玩法内监听方法类型说明​

字段说明
linkLoginListener点击登录：需处理逻辑（登录成功 => 上报注册/登录事件 => 重新打开玩法）；注：如果初始化设置了登录页url，此方法不会触发
linkEventListener点击去完成任务：需处理逻辑（完成任务 => 上报自定义事件（任务所绑定的事件） => 重新打开玩法），返回数据类型： 查看；注：如果任务配置了web_url，此方法不会触发
linkRedirectListener点击去使用奖品：返回数据类型： 查看；注：如果奖品配置了web_url，此方法不会触发
linkPointsListener点击区域埋点：返回数据类型： 查看；
linkCloseListener用户主动点击关闭活动窗口

PC端关闭活动窗口​


Turbolink.closeWebUrl().then((result) => {
  console.log(result)
})