@amplitude/plugin-user-agent-enrichment-browser

中文文档
1.0.1发布于 2023/08/10MITTypeScriptESM + CJS近 30 天下载 3.7万
中文使用文档
文档目录7 节
  1. 安装
  2. 使用量
  3. 1. 进口宽度包
  4. 2. 可靠用户代理浓缩插件
  5. 3. 安装插件到振幅 SDK
  6. 4. 振幅SDK初始化
  7. 生成页面查看事件


@amplitude/plugin-user- agent-富集浏览器

用于用户代理浓缩的官方浏览器 SDK插件.

安装

该软件包发布在国家预防机制登记册上,可用npm和纱线安装.

# npm
npm install @amplitude/plugin-user-agent-enrichment-browser@^1.0.0

# yarn
yarn add @amplitude/plugin-user-agent-enrichment-browser@^1.0.0

使用量

此插件在振幅浏览器SDK上方工作. 用于用用户代理信息丰富事件,使用@amplitude/ua-parser-js. 用户代理识别请求客户端的应用程序,操作系统,供应商和/或版本. 对于浏览器SDK v1.x,我们内部使用@amplitude/ua-parser-js来解析用户代理信息. 在浏览器 v2.x 中, 我们删除了这个客户端用户代理 解析器, 代之以执行服务器端用户代理 解析器 。 您可以使用此插件来保持与早期SDK版本的用户代理信息的一致性.

1. 进口宽度包

  • @amplitude/analytics-browser
  • @amplitude/plugin-user-agent-enrichment-browser
import * as amplitude from '@amplitude/analytics-browser';
import { userAgentEnrichmentPlugin } from '@amplitude/plugin-user-agent-enrichment-browser';

2. 可靠用户代理浓缩插件

插件接受一个可选参数,即 Object 以禁用/启用相应的跟踪选项。 每个选项默认启用 .

const uaPlugin = userAgentEnrichmentPlugin({
  osName: true,
  osVersion: true,
  deviceManufacturer: false,
  deviceModel: false,
});

选项

名称类型默认说明
osNamebooleantrue允许浓缩 os_name 属性.
osVersionbooleantrue允许浓缩 os_version 属性.
deviceManufacturerbooleantrue允许浓缩 device_manufacturer 属性.
deviceModelbooleantrue允许浓缩 device_model 属性.

3. 安装插件到振幅 SDK

amplitude.add(uaPlugin);

4. 振幅SDK初始化

amplitude.init('API_KEY');

生成页面查看事件

此插件使用 @ amplitude/ua- parser- js 解析用户代理信息, 并基于您的配置丰富事件 。 这影响到以下属性的价值: device_family, (中文(简体) ), device_model, (中文(简体) ), device_manufacturer, (中文(简体) ), device_type, (中文(简体) ), os, (中文(简体) ), os_name,以及 os_version。 。 。 .

版本与发布记录

@amplitude/plugin-user-agent-enrichment-browser 共发布 4 个版本,首次发布于 2023/07/27;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.1latest2023/08/103 年前
1.0.02023/08/013 年前
1.0.0-beta.1v1-beta2023/07/313 年前
0.1.02023/07/273 年前

关于 @amplitude/plugin-user-agent-enrichment-browser 的常见问题

如何安装 @amplitude/plugin-user-agent-enrichment-browser?

在项目目录运行 npm install @amplitude/plugin-user-agent-enrichment-browser,或使用 pnpm add / yarn add / bun add。

@amplitude/plugin-user-agent-enrichment-browser 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@amplitude/plugin-user-agent-enrichment-browser 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@amplitude/plugin-user-agent-enrichment-browser 可以商用吗?

@amplitude/plugin-user-agent-enrichment-browser 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@amplitude/plugin-user-agent-enrichment-browser 的下载量有多少?

根据 npm 官方下载统计,@amplitude/plugin-user-agent-enrichment-browser 在 2026/10/06 – 2026/11/04 这 30 天内被下载 36,624 次,日均约 1,221 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@amplitude/plugin-user-agent-enrichment-browser 还在维护吗?

最新版本 1.0.1 发布于 2023/08/10(3 年前);至今共发布 4 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/07/27。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。