微信小程序

1.引入行为采集

版本:1.0.0

下载链接:https://static.trustdecision.com/tdbh/index-wx-1.0.0.min.js

2.初始化 SDK

接口定义

function init(options)

init方法必传配置

配置 key定义说明示例代码
partner合作方编码合作方编码 partner code,请联系运营获取options['partner'] = '请输入您的合作方编码';
appKey应用标识应用标识,参考如何申请appKeyoptions['appKey'] = '请输入您的appKey';

原生开发

在入口文件app.js页面的最上方

import TDBehavior from './sdk'

//初始化
const options = {}
// 合作方编码,如 tongdun,参考`必传配置`
options['partner'] = '请输入您的合作方编码'
// 同盾平台注册的应用标识,参考`必传配置`
options['appKey'] = '请输入您的appKey'

TDBehavior.init(options)

注意:请在需要行为采集的页面都需要引用js文件

vue2

在main.js页面

import Vue from 'vue'
import App from './App'
// 在此处引入行为采集sdk && 调用初始化方法
import TDBehavior from './sdk'

//初始化
const options = {Vue}
// 合作方编码,如 tongdun,参考`必传配置`
options['partner'] = '请输入您的合作方编码'
// 同盾平台注册的应用标识,参考`必传配置`
options['appKey'] = '请输入您的appKey'

TDBehavior.init(options)

vue3

在main.js页面

import { createSSRApp } from 'vue'
import App from './App.vue'
// 在此处引入行为采集sdk
import TDBehavior from './sdk'

export function createApp() {
  const app = createSSRApp(App)
  
  //初始化
	const options = {app}
	// 合作方编码,如 tongdun,参考`必传配置`
	options['partner'] = '请输入您的合作方编码'
	// 同盾平台注册的应用标识,参考`必传配置`
	options['appKey'] = '请输入您的appKey'

	TDBehavior.init(options)

  return { app }
}

react

在main.js页面最上面(早于应用初始化):

import TDBehavior from './sdk'

...
import React from 'react'
...

//初始化
const options = {uni}
// 合作方编码,如 tongdun,参考`必传配置`
options['partner'] = '请输入您的合作方编码'
// 同盾平台注册的应用标识,参考`必传配置`
options['appKey'] = '请输入您的appKey'

TDBehavior.init(options)

taro

在app.js顶部尽早初始化(TDBehavior.init() 要在 App 创建前执行):

import TDBehavior from './sdk'

//初始化
const options = {}
// 合作方编码,如 tongdun,参考`必传配置`
options['partner'] = '请输入您的合作方编码'
// 同盾平台注册的应用标识,参考`必传配置`
options['appKey'] = '请输入您的appKey'

TDBehavior.init(options)

3.调用行为采集方法

行为采集方法用于获取用户行为数据,其接口定义如下:

/**
* TDBehavior collect,返回行为采集结果,如果SDK内部容器中存在数据,则会返回成功code == 0,同时清空SDK内部容器中的数据;
* 如果SDK内部容器中不存在数据则返回code == 104 错误码
*/
const result = TDBehavior.collect()

示例代码

    // 在调用业务接口时,调用 collect方法,获取行为采集数据,例如点击登录按钮
    const result = TDBehavior.collect()
    const code = result['code'];
    const msg = result['msg'];
    const payload = result['payload'];
    if (code === 0) {
        console.log('获取行为采集结果成功,payload: ' + payload);
    } else {
        console.log('获取行为采集结果失败,code: ' + code + ', msg: ' + msg);
    }

4.code 返回码

错误码描述处理方案
0success成功
100Please call init method first没有初始化
111missing runtime api缺少运行时,没有找到小程序(没有找到环境,比如wx,my,uni,App)
112unsupported runtime当前环境不支持行为采集(找到了环境,但不支持)
113please call init at the top of app.js初始化太晚
114Failed to access the page接入页面失败