开发手册Web SDKWebSDK 玩法

移动端加载活动URL

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

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

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弹出层背景色stringrgba(0, 0, 0, 0.8)
zIndex弹出层z-indexnumber3000
backgroundImage背景图地址string创建活动上传的图
backgroundWidth背景图宽度numberauto
backgroundHeight背景图高度number738px
width玩法窗口宽度number300px
height玩法窗口高度number650px
bgLinkage设置玩法窗口高宽时背景图是否联动变化booleanfalse
radius玩法窗口圆角number12px
bodyHidden窗口打开后是否禁止页面滑动booleantrue
jumpNewWindow玩法内页面跳转时是否新标签页打开页面booleanfalse(当前页打开)
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)
}) 

PC端创建活动入口

在调用方法前需要先进行’初始化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,直接赋值就好", 
  "iconUrl": "icon资源地址"
  "clickEventCallback": turbolinkEvenCallback // "玩法内监听方法点击回调,如:登录、去完成任务等",
}
 
Turbolink.createCampaignIcon(params).then((result) => {
  console.log(result)
}) 
参数说明类型必需默认值
urlTurboLink Dashboard后台的活动URL,直接赋值就好string
iconUrlicon资源地址string
positionicon位置 1:左上角 2:右上角 3:左下角 4:右下角number4
iconWidthicon宽度string50px
iconHeighticon高度string50px
iframeWidth活动视图宽度string300px
iframeHeight活动视图宽高度string600px
iconOffseticon距离活动视图的偏移量string10px
defaultOpen是否默认打开活动视图booleanfalse
iconRotate展开收起活动视图时icon是否旋转booleantrue
left左边距string20px
top上边距string20px
right右边距string20px
bottom下边距string20px
clickEventCallback玩法内监听方法回调说明 查看WebClickCallParam

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

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

玩法内监听方法类型说明

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

PC端移除活动入口

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