# @analytics/customerio 中文文档

规范地址：https://npmcn.com/package/%40analytics/customerio/

版本：0\.2\.2
npm 元数据更新时间：2022-11-09T05:36:41.927Z
中文译文更新时间：2026-11-06T01:52:55.269Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40analytics/customerio
原文对照：https://npmcn.com/package/%40analytics/customerio/?lang=original
项目主页：https://github.com/DavidWells/analytics#readme
源码仓库：https://github.com/DavidWells/analytics

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：34.1 kB，10 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2019-10-03T06:59:07.417Z
- 最新版本发布：2022-11-09T05:36:41.820Z
- 近 30 天下载量：15359（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

客户.io 整合“分析”模块

## 安装

```sh
npm install @analytics/customerio
```

也可以使用：`pnpm add @analytics/customerio`、`yarn add @analytics/customerio`、`bun add @analytics/customerio`

## README

# Customer.io 分析插件

与 [顾客.io](https://customer.io/) 页:1 [分析](https://www.npmjs.com/package/analytics) 软件包.

[查看文件](https://getanalytics.io/plugins/customerio/)

单击以扩展

-   [安装](https://npmcn.com/package/%40analytics/customerio/#readme-installation)
-   [如何使用](https://npmcn.com/package/%40analytics/customerio/#readme-how-to-use)
-   [支持的平台](https://npmcn.com/package/%40analytics/customerio/#readme-platforms-supported)
-   [浏览器使用量](https://npmcn.com/package/%40analytics/customerio/#readme-browser-usage)
    -   [浏览器 API](https://npmcn.com/package/%40analytics/customerio/#readme-browser-api)
    -   [浏览器配置选项](https://npmcn.com/package/%40analytics/customerio/#readme-configuration-options-for-browser)
-   [服务器侧用法](https://npmcn.com/package/%40analytics/customerio/#readme-server-side-usage)
    -   [服务器侧 API](https://npmcn.com/package/%40analytics/customerio/#readme-server-side-api)
    -   [服务器侧配置选项](https://npmcn.com/package/%40analytics/customerio/#readme-configuration-options-for-server-side)
-   [其他例子](https://npmcn.com/package/%40analytics/customerio/#readme-additional-examples)

## 安装

安装 `analytics` 财务报告和审定财务报表 `@analytics/customerio` 软件包

```bash
npm install analytics
npm install @analytics/customerio
```

## 如何使用

这个 `@analytics/customerio` 软件包在 [浏览器](https://npmcn.com/package/%40analytics/customerio/#readme-browser-usage) 财务报告和审定财务报表 [在节点.js的服务器侧](https://npmcn.com/package/%40analytics/customerio/#readme-server-side-usage)。要使用、安装软件包,在您的工程中包含并初始化插件 [分析](https://www.npmjs.com/package/analytics)。 。 。 .

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

```js
import Analytics from 'analytics'
import customerIOPlugin from '@analytics/customerio'

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    customerIOPlugin({
      siteId: '123-xyz'
    })
  ]
})

/* 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` 与 `customerIOPlugin` 插件, 数据将发送到 Customer.io [分析. p](https://getanalytics.io/api/#analyticspage), (中文(简体) ), [分析. track](https://getanalytics.io/api/#analyticstrack),或 [分析 识别](https://getanalytics.io/api/#analyticsidentify) 被调用.

见 [其他执行实例](https://npmcn.com/package/%40analytics/customerio/#readme-additional-examples) 在您的项目中使用更多细节 .

## 支持的平台

这个 `@analytics/customerio` 软件包在 [浏览器](https://npmcn.com/package/%40analytics/customerio/#readme-browser-usage) 财务报告和审定财务报表 [在节点.js的服务器侧](https://npmcn.com/package/%40analytics/customerio/#readme-server-side-usage)

## 浏览器使用量

Customer.io 客户端浏览器插件使用这些分析的 api 方法:

-   **[分析. p](https://getanalytics.io/api/#analyticspage)** - 将页面视图发送到Client.io
-   **[分析. 重置](https://getanalytics.io/api/#analyticsreset)** - 为客户.io值重置浏览器存储 cookie 和本地存储器
-   **[分析. track](https://getanalytics.io/api/#analyticstrack)** - 追踪自定义事件并发送给客户.io
-   **[分析 识别](https://getanalytics.io/api/#analyticsidentify)** - 确定访客身份,并向客户发送详情

### 浏览器 API

```js
import Analytics from 'analytics'
import customerIOPlugin from '@analytics/customerio'

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    customerIOPlugin({
      siteId: '123-xyz'
    })
  ]
})

```

### 浏览器配置选项

| 选项 | 说明 |
| :-- | :-- |
| `siteId`  
**所需经费** - 绳子 | 客户.io网站 客户端跟踪的ID |
| `customScriptSrc`  
_选项_ - 绳子 | 从自定义源装入客户端. io 脚本 |
| `disableAnonymousTraffic`  
_选项_ - 布尔 | 禁用匿名事件开火 |

## 服务器侧用法

Customer.io服务器侧节点.js插件使用这些分析的api方法:

-   **[分析. p](https://getanalytics.io/api/#analyticspage)** - 将页面视图发送到Client.io
-   **[分析. track](https://getanalytics.io/api/#analyticstrack)** - 追踪自定义事件并发送给客户.io
-   **[分析 识别](https://getanalytics.io/api/#analyticsidentify)** - 确定访客身份,并向客户发送详情

### 服务器侧 API

```js
import Analytics from 'analytics'
import customerIOServer from '@analytics/customerio'

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    customerIOServer({
      siteId: '123-xyz',
      apiKey: '9876543'
    })
  ]
})

```

### 服务器侧配置选项

| 选项 | 说明 |
| :-- | :-- |
| `siteId`  
**所需经费** - 绳子 | 客户.io网站 用于服务器侧跟踪的ID |
| `apiKey`  
**所需经费** - 绳子 | 客户端.io API 服务器侧跟踪密钥 |

## 其他例子

以下是其他执行实例.

服务器侧 ES6

```js
import Analytics from 'analytics'
import customerIOServer from '@analytics/customerio'

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    customerIOServer({
      siteId: '123-xyz',
      apiKey: '9876543'
    })
    // ...other 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'
})

```

具有共同JS的服务器端节点.js

如果使用节点,您将想要导入 `.default`

```js
const analyticsLib = require('analytics').default
const customerIOServer = require('@analytics/customerio').default

const analytics = analyticsLib({
  app: 'my-app-name',
  plugins: [
    customerIOServer({
      siteId: '123-xyz',
      apiKey: '9876543'
    })
  ]
})

/* 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'
})

```

在 HTML 中使用

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

```html
<!DOCTYPE html>
<html>
  <head>
    <title>Using @analytics/customerio in HTML</title>
    <script src="https://unpkg.com/analytics/dist/analytics.min.js"></script>
    <script src="https://unpkg.com/@analytics/customerio/dist/@analytics/customerio.min.js"></script>
    <script type="text/javascript">
      /* Initialize analytics */
      var Analytics = _analytics.init({
        app: 'my-app-name',
        plugins: [
          analyticsCustomerio({
            siteId: '123-xyz'
          })
        ]
      })

      /* 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/customerio` 在无害环境管理模块中.

```html
<!DOCTYPE html>
<html>
  <head>
    <title>Using @analytics/customerio 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 analyticsCustomerio from 'https://unpkg.com/@analytics/customerio/lib/analytics-plugin-customerio.browser.es.js?module'
      /* Initialize analytics */
      const Analytics = analytics({
        app: 'analytics-html-demo',
        debug: true,
        plugins: [
          analyticsCustomerio({
            siteId: '123-xyz'
          })
          // ... 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>

```

见 [分析提供者插件的完整列表](https://github.com/DavidWells/analytics#current-plugins) 在主重播时.

## 常见问题

### @analytics/customerio 是什么？

客户\.io 整合“分析”模块

### 如何安装 @analytics/customerio？

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

### @analytics/customerio 支持 TypeScript 吗？

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

### @analytics/customerio 支持 ESM 还是 CommonJS？

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

### @analytics/customerio 可以商用吗？

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

### @analytics/customerio 的下载量有多少？

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

### @analytics/customerio 还在维护吗？

最新版本 0\.2\.2 发布于 2022/11/09（3 年前）；至今共发布 4 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/10/03。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。