KuickDeal 小程序行为JS-SDK集成文档

目录

一、小程序SDK集成前工作

二、小程序SDK标准接入指南

三、模式选择

四、接口

四、更新日志

正文

KuickDeal wxApp-SDK 是 KuickDeal 开发平台向小程序开发者提供的用于向KuickDeal提交用户页面访问行为数据的开发工具包。此文档面向小程序开发者,介绍 KuickDeal wxApp-SDK 如何使用及相关注意事项。

一、小程序SDK集成前工作

1.1 确定集成SDK的项目,且添加小程序许可

img

二、小程序SDK标准接入指南

2.1 下载小程序SDK

下载 KuickDealSDK.js

curl --compressed https://deal.kuick.cn/wxApp-sdk/KuickDealSDK.js

2.2 添加跟踪代码

对于mpvue用户

// main.js
import Vue from 'vue'
import App from './App'
import kuickDealSDK from '@/lib/KuickDealSDK.js';

// 初始化sdk
let kdSDK = kuickDealSDK.init({
    kuickAppId: '${kuickAppId}', //kuick项目ID
    wxAppId: '${wxAppId}', //小程序ID
    // 选填
    kuickUserId: '${kuickUserId}', //销售人员的kuickUserId,
    //自动采集行为,建议开启,以最便于开发的方式收集行为
    autoAcquisition: true, // 布尔值,默认为true,

    // 开发配置
    logLevel: '${logLevel}', //日志级别,开发调试用,默认为1
}, 'vue', Vue);

// 正常初始小程序
// ……

2.3 关键行为埋点

mpvue,自动采集行为模式,首先需要在初始化SKD时,确认参数 autoAcquisitiontrue。随后在需要埋点的元素上,添加 data-title属性,其值为这个行为的描述。注意:要采集行为,需要目标元素触发vue methods中的事件。

<template>
    <div @click="demoEvent" data-title="这个行为的描述"></div>
</template>

<script>
export default {
    methods: {
        // 注意,埋点的时候,对应的点,methods对象里一定要有对应的事件,即使这个事件毫无意义
        demoEvent(){
            // 正常的业务逻辑
        }
    }
}
</script>

2.4 添加域名

登陆微信小程序后台,进入设置-->开发设置,在'服务器域名'选项中,添加https://deal-api.kuick.cnimg

三、模式说明

  • 模式由 autoAcquisition 参数控制,默认是自动采集模式
  • 行为采集,分为自动采集部分(自动模式)以及手动采集部分(手动模式)
  • 在自动模式下,SDK会采集用户所触发的所有有意义(元素上配置了data-title='行为描述')的行为。如,页面上的点击,分享(包括界面右上角自带分享),页面跳转等行为。这些行为是SDK内部自动采集的,除了必要的行为描述,不需要再做额外的开发
  • 在手动模式下,所有的行为都需要调用SDK接口产生相对应的记录

四、接口

4.1 实名客户

  • namedDealUser
    • 当获取用户信息后,需要调用 namedDealUser 实名化接口,实名这个客户
参数名称 参数类型 是否必填 参数说明
name string 姓名
title string 职称
email string 邮箱,如果填写邮箱,则需填写正确的邮箱格式
phone string 手机号,如果填写手机号,则需填写正确的手机号格式
company string 公司
unionid string 用户的微信unionId
appUserId string 用户在你们系统中对应的用户Id,做后端接口数据同步用
exts object 用户拓展字段
cb function 回调函数
// demo
kdSDK.ready(()=>{
    kdSDK.namedDealUser('杨黑娃', '销售', 'heiwa@kuaitui.cn', '', '快推', 'wx11', '${appUserId}', exts, cb);
});

4.2 开始浏览页面

  • onStartPage
    • 如果你想手动捕获一些自定义事件,可以调用 onStartPage
    • 自动模式下,SDK会根据page的 onShow 触发调用该接口
    • 注意,这个接口可以不需要等待SDK ready
    • 主要用于手动模式
参数名称 参数类型 是否必填 参数说明
title string 当前页面的标题
path string 当前页面的path路径
// 如果不传title,path,SDK内部会获取当前页面tite和path
kdSDK.onStartPage();

4.3 添加关键行为

  • onBehaviour
    • 主动添加关键行为
    • 自动模式下,SDK会以元素上data-title的值作为该接口的 description
    • 这个接口也可作为自动模式下的一个补充,比如支付,订单等一些非元素触发的行为,可以调用这个接口生成相对应的记录
    • 注意,这个接口可以不需要等待SDK ready
参数名称 参数类型 是否必填 参数说明
type string 事件类型,可选submit_form, play_media, download_file, click
description string 行为描述
content Object 行为的内容
// demo
//可以不需要等待SDK ready
kdSDK.onBehaviour('click', '杨黑娃点击了这个按钮', {
    info: '补充信息'
});

4.4 手动结束小程序

  • onEndApp
    • 当小程序退出时调用该接口
    • 主要用于手动模式
//可以不需要等待SDK ready
kdSDK.onEndApp();

四、更新日志

  • [2018-8-16] 微信小程序SDk1.0版本发布,支持mpvue模式下的自动埋点
北京西会科技有限公司©2015-2018 all right reserved,powered by Gitbook该文件修订时间: 2018-11-21 01:53:15

results matching ""

    No results matching ""