@analytics/customerio

中文文档
0.2.2发布于 2022/11/09MITESM + CJS近 30 天下载 1.5万

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

中文使用文档
文档目录10 节
  1. 安装
  2. 如何使用
  3. 支持的平台
  4. 浏览器使用量
  5. 浏览器 API
  6. 浏览器配置选项
  7. 服务器侧用法
  8. 服务器侧 API
  9. 服务器侧配置选项
  10. 其他例子

Customer.io 分析插件

与 顾客.io 页:1 分析 软件包.

查看文件

单击以扩展

安装

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

npm install analytics
npm install @analytics/customerio

如何使用

这个 @analytics/customerio 软件包在 浏览器 财务报告和审定财务报表 在节点.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, (中文(简体) ), 分析. track,或 分析 识别 被调用.

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

支持的平台

这个 @analytics/customerio 软件包在 浏览器 财务报告和审定财务报表 在节点.js的服务器侧

浏览器使用量

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

  • 分析. p - 将页面视图发送到Client.io
  • 分析. 重置 - 为客户.io值重置浏览器存储 cookie 和本地存储器
  • 分析. track - 追踪自定义事件并发送给客户.io
  • 分析 识别 - 确定访客身份,并向客户发送详情

浏览器 API

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方法:

服务器侧 API

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
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

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导入的例子. 请注意,这将拉入该套件的最新版本.

<!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 在无害环境管理模块中.

<!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>

见 分析提供者插件的完整列表 在主重播时.

版本与发布记录

@analytics/customerio 共发布 4 个版本,首次发布于 2019/10/03;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.2.2latest2022/11/093 年前
0.2.12020/12/235 年前
0.2.02019/10/147 年前
0.1.72019/10/037 年前

关于 @analytics/customerio 的常见问题

@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 和提交记录判断。