微信小程序 SDK

AntDock 微信小程序 SDK 专为微信小程序环境设计，提供完整的用户行为追踪能力。

SDK 获取方式

使用控制台提供的安装地址或下载包；本文不表示 SDK 已在公共仓库开源发布。

安装

将 SDK 源码文件复制到您的小程序项目中：

1. 下载 sdk/miniprogram/src/ 目录下的文件
2. 复制到小程序项目的 utils/antdock/ 目录
3. 在需要的地方引入使用

初始化

在 app.js 中初始化 SDK：

// app.js
const AntDockTracker = require('./utils/antdock/index')

App({
  onLaunch(options) {
    AntDockTracker.init({
      appId: 'your-app-id',
      endpoint: 'https://你的域名',

      // 可选配置
      autoTrack: true,          // 自动追踪页面
      batchSize: 10,            // 批量大小
      flushInterval: 5000,      // 刷新间隔 (ms)
      debug: false              // 调试模式
    })
  },

  onHide() {
    AntDockTracker.flush()  // 确保数据发送
  }
})

页面追踪

// pages/index/index.js
const AntDockTracker = require('../../utils/antdock/index')

Page({
  onShow() {
    AntDockTracker.trackPageView('/pages/index/index')
  }
})

API 参考

trackPageView(path, properties?)

追踪页面访问。

AntDockTracker.trackPageView('/pages/product/detail', {
  product_id: '12345'
})

trackEvent(name, properties?)

追踪自定义事件。

AntDockTracker.trackEvent('button_click', {
  button_name: 'add_to_cart'
})

AntDockTracker.trackEvent('purchase', {
  order_id: 'ORD-12345',
  amount: 99.99
})

identify(userId, traits?)

识别用户身份。

AntDockTracker.identify(openid, {
  nickname: userInfo.nickName,
  avatar: userInfo.avatarUrl
})

flush()

立即发送队列中的数据。

reset()

重置用户身份。

域名配置

在微信公众平台添加合法域名：

1. 登录 微信公众平台
2. 开发 → 开发设置 → 服务器域名
3. 添加 request 合法域名: https://你的域名

注意事项

1. 存储限制: 小程序本地存储限制 10MB
2. 网络限制: 确保域名已添加到白名单
3. 隐私合规: 确保在隐私协议中说明数据收集行为