@amplitude/plugin-autocapture-browser (β) (中文(简体) )
这个插件目前位于β中,命名和界面可能会在未来发生变化.
自动抓取的浏览器 SDK 插件 .
安装
该软件包发布在国家预防机制登记册上,可用npm和纱线安装.
# npm
npm install @amplitude/plugin-autocapture-browser@beta
# yarn
yarn add @amplitude/plugin-autocapture-browser@beta
使用量
这个插件在Amplitude浏览器SDK上方工作,生成自动跟踪的事件并发送到Amplitude.
阴影DOM: 通过 shadowDomEnabled 选项(本地打开) elementInteractions,或者通过远程配置). 见 SHADOW-DOM.MD (英语)。 。 。 .
要使用此插件, 您需要安装 @amplitude/analytics-browser 版本 v1.9.1 或后会.
1. 进口宽度包
@amplitude/analytics-browser@amplitude/plugin-autocapture-browser
import * as amplitude from '@amplitude/analytics-browser';
import { autocapturePlugin } from '@amplitude/plugin-autocapture-browser';
2. 说明插件
插件接受一个可选参数,即 Object 来配置允许的跟踪选项.
const plugin = autocapturePlugin({
cssSelectorAllowlist: [
'.amp-tracking',
'[amp-tracking]'
],
pageUrlAllowlist: [
'https://amplitude.com',
new RegExp('https://amplitude.com/blog/*')
],
pageUrlExcludelist: [
'https://amplitude.com/admin',
new RegExp('^https:\\/\\/amplitude\\.com\\/private\\/.*$')
],
});
实例:
- 以上情况
cssSelectorAllowlist只允许跟踪元素, 如:<button amp-tracking>Click</button><a class="amp-tracking">Link</a>
- 以上情况
pageUrlAllowlist只允许跟踪“https://amplitude.com”或任何匹配“https://amplitude.com/blog/*”的URL上的元素 - 以上情况
pageUrlExcludelist将屏蔽 URL "https://amplitude.com/admin" 或任何匹配"^https:\/\/amplitude\.com\/private\/.*$"模式的URL跟踪,即使它们符合许可列表
选项
| 名称 | 类型 | 默认 | 说明 |
|---|---|---|---|
cssSelectorAllowlist | string[] | ['a', 'button', 'input', 'select', 'textarea', 'label', '[data-amp-default-track]', '.amp-default-track'] | 提供时只允许跟踪匹配任何选择器的元素. |
pageUrlAllowlist | (string|RegExp)[] | undefined | 提供时,只允许跟踪匹配URL的元素. |
pageUrlExcludelist | (string|RegExp)[] | undefined | 在提供时, 块跟踪匹配 URL 的元素 。 优于许可名单. |
shouldTrackEventResolver | (actionType: ActionType, element: Element) => boolean | undefined | 提供时, 覆盖所有其他允许列表和配置 . |
dataAttributePrefix | string | 'data-amp-track-' | 允许在事件属性中收集数据属性 . |
3. 安装插件到振幅 SDK
amplitude.add(plugin);
4. 振幅SDK初始化
amplitude.init('API_KEY');