# @attraqt/activity 中文文档

规范地址：https://npmcn.com/package/%40attraqt/activity/

版本：2\.0\.0
npm 元数据更新时间：2023-11-09T17:05:56.247Z
中文译文更新时间：2026-11-07T04:09:06.038Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40attraqt/activity
原文对照：https://npmcn.com/package/%40attraqt/activity/?lang=original
项目主页：https://github.com/attraqt/attraqt-js/tree/master/packages/activity
源码仓库：https://github.com/attraqt/attraqt-js

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

- 包体积（解压后）：82.1 kB，25 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：7 个
- 首次发布：2020-04-27T12:38:21.383Z
- 最新版本发布：2023-11-09T17:05:56.043Z
- 近 30 天下载量：2572（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：24（近 12 个月 0 个）

## 中文简介

## 安装和使用

## 安装

```sh
npm install @attraqt/activity
```

也可以使用：`pnpm add @attraqt/activity`、`yarn add @attraqt/activity`、`bun add @attraqt/activity`

## README

# @ atraqt/ 活动

## 安装和使用

```bash
npm install --save @attraqt/activity
```

```js
import {activity} from @attraqt/activity

activity.init({
  trackerKey: "YOUR_TRACKER_KEY",
  region: "WEBSITE_REGION"  // optional, set to EU by default
});

activity.setUser({
  identities: {
    sessionid: "YOUR_SESSION_ID"
  },
  traits: {
    birthday: "2020-04-01"
  },
  segments: ["segment1"]
});

activity.send({
  action: "view",
  target: {
    product: "YOUR_PRODUCT_ID"
  }
});
```

## 方法

| 方法 | 参数 | 结果 | 说明 |
| --- | --- | --- | --- |
| 输入 | 选项: [`ActivityInitOptions`](https://npmcn.com/package/%40attraqt/activity/src/activity.ts) | `void` | 初始化活动客户端 |
| 发送 | 活动: [`Activity | Activity[]`](https://npmcn.com/package/%40attraqt/activity/src/models/activity.ts)选项 : [`SendActivityOptions`](https://npmcn.com/package/%40attraqt/activity/src/activity.ts) | `Promise<Response>` | 发送活动 |
| set 用户 | 用户 : [`User`](https://npmcn.com/package/%40attraqt/activity/src/models/activity.ts) | `void` | 设置要随未来活动一起发送的用户 |
| 清除用户 |  | `void` | 清除先前设定的用户 |
| 添加用户标识 | 身份仓库 : `string`,标识 : `string` | `void` | 设置用户身份 |
| 用户身份 | 身份 : `{[identityRepository: string]: string}` | `void` | 设置用户身份 |
| 添加用户分区 | 线段 : `string` | `void` | 向用户添加一段 |
| 用户块 | 区段 : `string[]` | `void` | 设置用户段 |
| 添加用户图案 | 特性 : `string`,特性: `string` | `void` | 向用户添加特性 |
| 用户轨迹 | 特征 : `{[trait: string]: string}` | `void` | 设置用户特性 |
| 获取用户组合 |  | `Promise<`[集群](https://npmcn.com/package/%40attraqt/activity/src/models/activity.ts)`>` | 获取用户集群 |

## 常见问题

### @attraqt/activity 是什么？

安装和使用

### 如何安装 @attraqt/activity？

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

### @attraqt/activity 支持 TypeScript 吗？

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

### @attraqt/activity 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @attraqt/activity 可以商用吗？

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

### @attraqt/activity 的下载量有多少？

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

### @attraqt/activity 还在维护吗？

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