安装与使用

1. 安装：在小程序代码根目录下执行 tnpm install @tencent/wxobs-miniprogram-sdk
2. 构建：在微信开发者工具中，点击左上角菜单栏中“工具” -> “构建npm”
3. 使用：在 app.js 文件中引入 setup 函数，并在 onLaunch 中执行即可启动采集。

示例代码：

import wxobs from '@tencent/wxobs-miniprogram-sdk';

App({
  onLaunch: function () {
    wxobs.setup({
      isWhitelistMaskMode: true
    })
  },
});

API

setup

配置并启动用户行为采集。 参数：

{
  isWhitelistMaskMode?: boolean // 可选，默认值 true。true 表示以白名单模式遮罩小程序中的元素，false表以黑名单模式遮罩小程序中的元素。
  autoStart?: boolean // 可选，默认值 true。是否自动开采集。若为 false，需自行调用 start 函数启动采集。
  attrs?: Record<string, string> // 对回放添加属性，在管理端可通过属性筛选回访
  captureDataAttrs?: boolean // 可选，默认为 true。采集 webview 中的元素时，是否采集以 data-* 为开头的属性
  shouldCapturePage?: (page: string, query: Record<string, string>) => boolean // 可选。用于控制是否采集某页面的回调，page 和 query 是该页面的属性，默认为全部采集。
}

setAttrs

param

attrs: Record<string, string> // 属性的键值对

向当前回放添加键值对属性，回放端可通过该属性筛选回放。

example

setAttrs({
  gender: 'male',
  age: '18',
})

文档

隐私

屏蔽

为保护用户隐私，采集模块屏蔽了以下数据：

• 所有 input 事件
• open-data
• 小程序插件内容

遮罩

采集模块提供了对图片、视频、文本内容的遮罩功能。对需要遮罩的图片和视频，采集模块会将原图片或视频替换成骨架图上报，文本则替换成星号。

开发者可根据需要，在 setup 时配置 isWhitelistMaskMode 来选择白名单遮罩模式或黑名单遮罩模式。

在白名单模式下，SDK 会默认遮罩所有的元素，开发者可以在元素上添加类 "wxobs-unmask" 来解除该元素及其子元素的遮罩。 如

<view class="wxobs-unmask">
	...
</view>

在黑名单模式下，所有元素默认不遮罩。开发者可以针对敏感元素，在元素上添加类 "wxobs-mask" 来遮罩该元素及其子元素。 如

<view class="wxobs-mask">
	...
</view>