开发手册Web SDKWebSDK 事件

初始化SDK

npm模式

import Turbolink from 'turbolink-ai';
 
const params = {
  "appKey": "your AppKey",
  "appSecret": "your AppSecret",
  "projectId": "your projectId", 
  "uid": "<你的用户ID，非必填>",
  "lv": "<你的用户标识，非必填>",
  "lang": "<语言代码，非必填>",
  "loginUrl": "<用户登录页面地址（PC端不建议传入），非必填>" //1.2.3版本起：仅移动端生效，PC端使用回调方法
  "jump": "<归因成功是否自动打开活动，非必填>",
  "clickEventCallback": "<回调方法>"  //1.2.2版本起：玩法内监听方法点击回调，如：登录、去完成任务等（仅PC端生效）
}
 
Turbolink.init(params).then((result) => {
  if(result.code == 200){
    console.log("初始化成功、可调用上报方法")
  }
})

使用js文件模式

<script type="text/javascript" src="path/to/turbolink-latest.min.js"></script>
<script type="text/javascript"> 
  Turbolink.init({
      "appKey": "your AppKey",
      "appSecret": "your AppSecret",
      "projectId": "your projectId",
      "uid": "<你的用户ID，非必填>",
      "lv": "<你的用户标识，非必填>",
      "lang": "<语言代码，非必填>",
      "loginUrl": "<用户登录页面地址（PC端不建议传入），非必填>", //1.2.3版本起：仅移动端生效，PC端使用回调方法
      "jump": "<归因成功是否自动打开活动，非必填>",
      "clickEventCallback": "<回调方法>"  //1.2.2版本起：玩法内监听方法点击回调，如：登录、去完成任务等（仅PC端生效）
  }).then((result) => {
    if(result.code == 200){ 
      console.log("初始化成功、可调用上报方法")
    }
  })
</script>

初始化init方法参数说明

参数说明类型必需默认值
appKeyApi通讯凭证,用来识别和鉴权调用者的身份。查看string是无
appSecret唯一性请求加密串。 查看string是无
projectId项目 id 获取projectIDstring是无
uid您App的用户体系 IDstring ｜ number否无
lv用户标识，如：等级(v1,v2), 标签(us,cn)string否null
lang语言代码 查看string否null
loginUrl登录页面地址（用户在活动内需要登录时跳转到的地址），PC端不建议传入；1.2.3版本起：仅移动端生效，PC端使用回调方法string否null
jump归因成功是否自动打开活动 (对于活动，在Install/Open事件时，归因命中会返回活动的页面URL，这时是否直接打开该活动)boolean否true
clickEventCallback1.2.2版本起：玩法内监听方法回调说明 查看WebClickCallParam否无

result数据说明

字段说明类型默认值
code状态码，例：200 === 成功Number无
message消息string无
data上报成功返回的数据 查看object无

设置用户

设置您的APP用户ID，如果init已经有设置在这里就不需要

const params = {
    "uid": "<你的用户ID>", 
    "lv": "<你的用户标识，非必填>"
}
Turbolink.setIdentity(params).then((result)=>{
   console.log(result)
})

注册事件

在用户注册完成时上报该事件

const params = {
    "uid": "<你的用户ID>",
    "lv": "<你的用户标识，非必填>",
    "toActivity":"<移动端未登录状态打开过活动后，是否自动回到活动（默认true），非必填，仅移动端生效>"
}
Turbolink.register(params).then((result) => {
  console.log(result)
})

登录事件

在用户登录完成时上报该事件

const params = {
    "uid": "<你的用户ID>",
    "lv": "<你的用户标识，非必填>",
    "toActivity":"<移动端未登录状态打开过活动后，是否自动回到活动（默认true），非必填，仅移动端生效>"
}
Turbolink.login(params).then((result) => {
  console.log(result)
})

登出事件

在用户登出完成时上报该事件

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

自定义事件

如果你想自己定义事件埋点以满足业务需求，可以使用自定义事件在你的应用任意地方进行埋点。 自定义事件管理在:Dashboard->智链触达->事件管理

const params = {
  "event": "Event name",
  "backCamp": "<完成自定义任务后是否自动跳转回玩法主页，非必填，仅移动端生效>",
  "customData": [{"key": "自定义事件参数键","value": "自定义事件参数值"}]
}
Turbolink.customEvent(params).then((result) => {
  console.log(result)
})

口令搜索

在需要通过口令内容检索时使用

Turbolink.codeSearch("<口令内容>").then((result) => {
  console.log(result)
})
WebSDK 集成WebSDK 玩法