@ 标注/ 统一
官方的振幅SDK用于网络分析,实验,会话回放,指南和调查等.
完全振幅 统一SDK文档 (https://amplitude.com/docs/sdks/analytics/browser/browser-unifed-sdk) (中文(简体) )
安装
该软件包发布在国家预防机制登记册上,可用npm和纱线安装.
# npm
npm install @amplitude/unified
# yarn
yarn add @amplitude/unified
使用量
统一SDK为包括分析、实验和会话重放在内的所有振幅特性提供了一个单一的切入点。 它通过处理所有组件的初始化和配置来简化整合过程.
1. 初始化振幅统一SDK
import { Identify, experiment, identify, initAll, sessionReplay, track } from '@amplitude/unified';
await initAll('YOUR_API_KEY', {
// Shared options for all SDKs (optional)
serverZone: 'US', // or 'EU'
instanceName: 'my-instance',
// Analytics options
analytics: {
// Analytics configuration options
},
// Session Replay options
sessionReplay: {
// Session Replay configuration options
},
// Experiment options
experiment: {
// Experiment configuration options
},
// Guides and Surveys options
engagement: {
// Guides and Surveys configuration options
},
});
2. 访问 SDK 特性
统一SDK通过单一的接口提供对所有振幅特性的访问:
// Track events
track('Button Clicked', { buttonName: 'Sign Up' });
// Identify users
identify(new Identify().set('userType', 'premium'));
// Access Experiment features
const experimentClient = experiment();
if (experimentClient) {
await experimentClient.fetch();
const variant = experimentClient.variant('experiment-key');
}
// Access Session Replay features
await sessionReplay()?.flush(false);
// Access Guides and Surveys features via engagement global
const activeGuidesAndSurveys = window.engagement.gs.list();
配置选项
共享选项
| 名称 | 类型 | 默认 | 说明 |
|---|---|---|---|
serverZone | 'US' 或者说 'EU' | 'US' | 所有 SDK 使用的服务器区域 . |
instanceName | string | undefined | 这是SDK的独有名称. |
分析选项
所有选项来自 @amplitude/analytics-browser 被支持。 见 分析浏览器 SDK 文档 详细情况.
会话重放选项
所有选项来自 @amplitude/plugin-session-replay-browser 被支持。 见 会话重放插件文档 详细情况.
实验选项
所有选项来自 @amplitude/plugin-experiment-browser 被支持。 见 实验文件 详细情况.
指南和调查选项
所有选项来自 @amplitude/engagement-browser 被支持。 见 指南和调查文件 详细情况.