# @datapunt/matomo-tracker-js 中文文档

规范地址：https://npmcn.com/package/%40datapunt/matomo-tracker-js/

版本：0\.5\.1
npm 元数据更新时间：2022-04-05T03:02:01.724Z
中文译文更新时间：2026-11-11T15:04:00.499Z
软件包许可：MPL-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40datapunt/matomo-tracker-js
原文对照：https://npmcn.com/package/%40datapunt/matomo-tracker-js/?lang=original
项目主页：https://github.com/Amsterdam/matomo-tracker#readme
源码仓库：https://github.com/Amsterdam/matomo-tracker

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

- 包体积（解压后）：80.3 kB，35 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2019-08-15T10:15:51.508Z
- 最新版本发布：2021-08-11T07:56:03.449Z
- 近 30 天下载量：74753（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：29（近 12 个月 0 个）

## 中文简介

前端项目的 Matomo 跟踪器

## 安装

```sh
npm install @datapunt/matomo-tracker-js
```

也可以使用：`pnpm add @datapunt/matomo-tracker-js`、`yarn add @datapunt/matomo-tracker-js`、`bun add @datapunt/matomo-tracker-js`

## README

# 马托莫追踪器( JavaScript)

在前端项目中使用 Matamo 跟踪的独立库

## 安装

```sh
npm install @datapunt/matomo-tracker-js
```

## 使用量

在您使用这台Matomo Tracker之前, 您需要初始化 Matomo, 您的项目具体细节 .

**初始化 :**

```ts
import MatomoTracker from '@datapunt/matomo-tracker-js'

const tracker = new MatomoTracker({
  urlBase: 'https://LINK.TO.DOMAIN',
  siteId: 3,
  userId: 'UID76903202', // optional, default value: `undefined`.
  trackerUrl: 'https://LINK.TO.DOMAIN/tracking.php', // optional, default value: `${urlBase}matomo.php`
  srcUrl: 'https://LINK.TO.DOMAIN/tracking.js', // optional, default value: `${urlBase}matomo.js`
  disabled: false, // optional, false by default. Makes all tracking calls no-ops if set to true.
  heartBeat: { // optional, enabled by default
    active: true, // optional, default value: true
    seconds: 10 // optional, default value: `15
  },
  linkTracking: false, // optional, default value: true
  configurations: { // optional, default value: {}
    // any valid matomo configuration, all below are optional
    disableCookies: true,
    setSecureCookie: true,
    setRequestMethod: 'POST'
  }
})
```

初始化后, 您可以使用 Matomo 跟踪器来跟踪类似事件和页面视图 :

```ts
import MatomoTracker from '@datapunt/matomo-tracker-js'

const tracker = new MatomoTracker({
  /* setup */
})

tracker.trackPageView()

tracker.trackEvent({
  category: 'sample-page',
  action: 'click-event',
  name: 'test', // optional
  value: 123, // optional, numerical value
})

tracker.trackLink({
  href: 'https://link-to-other-website.org',
})
```

## 高级用途

默认情况下,Matomo Tracker会发送窗口的文档标题和位置,但您可以发送自己的值. 还有.., [自定义维度](https://matomo.org/docs/custom-dimensions/) 可用于:

```ts
import MatomoTracker from '@datapunt/matomo-tracker-js'

const tracker = new MatomoTracker({
  /* setup */
})

tracker.trackPageView({
  documentTitle: 'Page title', // optional
  href: 'https://LINK.TO.PAGE', // optional
  customDimensions: [
    {
      id: 1,
      value: 'loggedIn',
    },
  ], // optional
})

tracker.trackEvent({
  category: 'sample-page',
  action: 'click-event',
  name: 'test', // optional
  value: 123, // optional, numerical value
  documentTitle: 'Page title', // optional
  href: 'https://LINK.TO.PAGE', // optional
  customDimensions: [
    {
      id: 1,
      value: 'loggedIn',
    },
  ], // optional
})

tracker.trackLink({
  href: 'https://link-to-your-file.pdf',
  linkType: 'download', // optional, default value 'link'
})
```

除了追踪事件之外,该项目还支持追踪现场搜索:

```ts
import MatomoTracker from '@datapunt/matomo-tracker-js'

const tracker = new MatomoTracker({
  /* setup */
})

tracker.trackSiteSearch({
  keyword: 'test',
  category: 'blog', // optional
  count: 4, // optional
  documentTitle: 'Page title', // optional
  href: 'https://LINK.TO.PAGE', // optional
  customDimensions: [
    {
      id: 1,
      value: 'loggedIn',
    },
  ], // optional
})
```

或者如果您想要远离内置的 JavaScript 事件, 此工程可用于从带有数据属性的按钮跟踪事件 :

**HTML5 数据属性**

```html
<button
  data-matomo-event="click"
  data-matomo-category="sample-page"
  data-matomo-action="click-event"
  data-matomo-name="test" // optional
  data-matomo-value="123" // optional, numerical value
  type="button">
  Track me!
</button>
```

```ts
import MatomoTracker from '@datapunt/matomo-tracker-js'

const tracker = new MatomoTracker({
  /* setup */
})

// Load the event listeners
tracker.trackEvents()

// Track page views
tracker.trackPageView()
```

## 参考资料

-   [Matomo JavaScript 跟踪指南](https://developer.matomo.org/guides/tracking-javascript-guide)

## 常见问题

### @datapunt/matomo-tracker-js 是什么？

前端项目的 Matomo 跟踪器

### 如何安装 @datapunt/matomo-tracker-js？

在项目目录运行 npm install @datapunt/matomo-tracker-js，或使用 pnpm add / yarn add / bun add。

### @datapunt/matomo-tracker-js 支持 TypeScript 吗？

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

### @datapunt/matomo-tracker-js 支持 ESM 还是 CommonJS？

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

### @datapunt/matomo-tracker-js 可以商用吗？

@datapunt/matomo-tracker-js 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @datapunt/matomo-tracker-js 的下载量有多少？

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

### @datapunt/matomo-tracker-js 还在维护吗？

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