@analytics/amplitude

中文文档
0.1.3发布于 2021/10/30MITESM + CJS零依赖近 30 天下载 3.8万

“分析”模块的高度集成

中文使用文档
文档目录8 节
  1. 安装
  2. 如何使用
  3. 支持的平台
  4. 浏览器使用量
  5. 浏览器 API
  6. 浏览器配置选项
  7. 其他例子
  8. 设置自定义会话编号

广度

此库输出 amplitude 该插件 analytics 软件包.

此分析插件将载入您的应用程序中 .

详情 见文件。 。 。 .

单击以扩展

安装

npm install analytics
npm install @analytics/amplitude

如何使用

这个 @analytics/amplitude 软件包在 浏览器。要使用、安装软件包,在您的工程中包含并初始化插件 分析。 。 。 .

以下为如何使用浏览器插件的例子.

import Analytics from 'analytics'
import amplitudePlugin from '@analytics/amplitude'

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    amplitudePlugin({
      apiKey: 'token',
      // See options at https://bit.ly/3dRdZnE
      options: {
        trackingOptions: {
          ip_address: false
        }
      }
    })
  ]
})

/* Track a page view */
analytics.page()

/* Track a custom event */
analytics.track('cartCheckout', {
  item: 'pink socks',
  price: 20
})

/* Identify a visitor */
analytics.identify('user-id-xyz', {
  firstName: 'bill',
  lastName: 'murray'
})

初始化后 analytics 与 amplitudePlugin 插件, 数据将发送到振幅 分析. p, (中文(简体) ), 分析. track,或 分析 识别 被调用.

见 其他执行实例 在您的项目中使用更多细节 .

支持的平台

这个 @analytics/amplitude 软件包在 浏览器

浏览器使用量

振幅客户端浏览器插件使用这些分析的 api 方法:

浏览器 API

import Analytics from 'analytics'
import amplitudePlugin from '@analytics/amplitude'

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    amplitudePlugin({
      apiKey: 'token',
      // See options at https://bit.ly/3dRdZnE
      options: {
        trackingOptions: {
          ip_address: false
        }
      }
    })
  ]
})

浏览器配置选项

选项说明
apiKey
所需经费 - 绳子
高度工程 API 密钥
options
所需经费 - 对象
高度 SDK 选项
initialSessionId
所需经费 - 绳子
设定初始会话 ID

其他例子

以下是其他执行实例.

在 HTML 中使用

以下是通过unpkg CDN导入的例子. 请注意,这将拉入该套件的最新版本.

<!DOCTYPE html>
<html>
  <head>
    <title>Using @analytics/amplitude in HTML</title>
    <script src="https://unpkg.com/analytics/dist/analytics.min.js"></script>
    <script src="https://unpkg.com/@analytics/amplitude/dist/@analytics/amplitude.min.js"></script>
    <script type="text/javascript">
      /* Initialize analytics */
      var Analytics = _analytics.init({
        app: 'my-app-name',
        plugins: [
          undefined({
            apiKey: 'token',
            // See options at https://bit.ly/3dRdZnE
            options: {
              trackingOptions: {
                ip_address: false
              }
            }
          })
        ]
      })

      /* Track a page view */
      analytics.page()

      /* Track a custom event */
      analytics.track('cartCheckout', {
        item: 'pink socks',
        price: 20
      })

      /* Identify a visitor */
      analytics.identify('user-id-xyz', {
        firstName: 'bill',
        lastName: 'murray'
      })
    </script>
  </head>
  <body>
    ....
  </body>
</html>

通过 ES 模块在 HTML 中使用

使用 @analytics/amplitude 在无害环境管理模块中.

<!DOCTYPE html>
<html>
  <head>
    <title>Using @analytics/amplitude in HTML via ESModules</title>
    <script>
      // Polyfill process.
      // **Note**: Because `import`s are hoisted, we need a separate, prior <script> block.
      window.process = window.process || { env: { NODE_ENV: 'production' } }
    </script>
    <script type="module">
      import analytics from 'https://unpkg.com/analytics/lib/analytics.browser.es.js?module'
      import undefined from 'https://unpkg.com/@analytics/amplitude/lib/analytics-plugin-amplitude.browser.es.js?module'
      /* Initialize analytics */
      const Analytics = analytics({
        app: 'analytics-html-demo',
        debug: true,
        plugins: [
          undefined({
            apiKey: 'token',
            // See options at https://bit.ly/3dRdZnE
            options: {
              trackingOptions: {
                ip_address: false
              }
            }
          })
          // ... add any other third party analytics plugins
        ]
      })

      /* Track a page view */
      analytics.page()

      /* Track a custom event */
      analytics.track('cartCheckout', {
        item: 'pink socks',
        price: 20
      })

      /* Identify a visitor */
      analytics.identify('user-id-xyz', {
        firstName: 'bill',
        lastName: 'murray'
      })
    </script>
  </head>
  <body>
    ....
  </body>
</html>

设置自定义会话编号

您可以设置一个会话 ID 这样

import Analytics from 'analytics'
import amplitudePlugin from '@analytics/amplitude'

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    amplitudePlugin({
      apiKey: 'token',
    })
  ]
})

// Run custom method https://getanalytics.io/plugins/writing-plugins/#adding-custom-methods
analytics.plugins['amplitude'].setSessionId('your-id')

或者通过 initialSessionId 配置值

import Analytics from 'analytics'
import amplitudePlugin from '@analytics/amplitude'

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    amplitudePlugin({
      apiKey: 'token',
      initialSessionId: 'xyz-123'
    })
  ]
})

版本与发布记录

@analytics/amplitude 共发布 8 个版本,首次发布于 2021/04/09;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.1.3latest2021/10/305 年前
0.1.22021/10/255 年前
0.1.12021/10/255 年前
0.1.02021/10/245 年前
0.0.42021/10/245 年前
0.0.32021/04/205 年前

关于 @analytics/amplitude 的常见问题

@analytics/amplitude 是什么?

“分析”模块的高度集成

如何安装 @analytics/amplitude?

在项目目录运行 npm install @analytics/amplitude,或使用 pnpm add / yarn add / bun add。

@analytics/amplitude 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/analytics__amplitude 是否存在。

@analytics/amplitude 支持 ESM 还是 CommonJS?

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

@analytics/amplitude 可以商用吗?

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

@analytics/amplitude 的下载量有多少?

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

@analytics/amplitude 还在维护吗?

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