# @braze/web-sdk-core 中文文档

规范地址：https://npmcn.com/package/%40braze/web-sdk-core/

版本：3\.5\.1
npm 元数据更新时间：2023-12-21T18:54:01.084Z
中文译文更新时间：2026-11-08T14:21:43.884Z
软件包许可：SEE LICENSE IN https://github\.com/Appboy/appboy-web-sdk/blob/master/LICENSE

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

原始 npm 页面：https://www.npmjs.com/package/%40braze/web-sdk-core
原文对照：https://npmcn.com/package/%40braze/web-sdk-core/?lang=original
项目主页：https://github.com/Appboy/appboy-web-sdk#readme
源码仓库：https://github.com/Appboy/appboy-web-sdk

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

- 包体积（解压后）：223 kB，4 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2020-06-08T21:50:49.601Z
- 最新版本发布：2022-03-24T19:11:26.907Z
- 近 30 天下载量：6884（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 0 个）

## 中文简介

网站和其他JS平台的核心Braze SDK(无UI).

## 安装

```sh
npm install @braze/web-sdk-core
```

也可以使用：`pnpm add @braze/web-sdk-core`、`yarn add @braze/web-sdk-core`、`bun add @braze/web-sdk-core`

## README

# 安装

```shell
$ npm install --save @braze/web-sdk-core
```

这将将 Braze 网络 SDK 文件安装到 `./node_modules/@braze/web-sdk-core` 在那里你可以参考他们的地方。 注意:Braze Web SDK的用意是用于网页应用程序中的客户端侧面,可能无法在Node.js服务器环境中如预期的那样工作.

# 使用量

注意SDK的这个核心版本并不包含Braze的内置UI能力(任何 [appboy.display (英语)](https://js.appboycdn.com/web-sdk/latest/doc/module-display.html) 方法问题。 您需要执行您自己的In- App 消息卡和内容卡的 UI 。 请注意,我们的UI元素通过cs可以完全定制,所以我们一般建议整合 [完整库](https://www.npmjs.com/package/@braze/web-sdk) 换句话说.

```javascript
var appboy = require('@braze/web-sdk-core');
appboy.initialize('YOUR-API-KEY', { baseUrl: 'YOUR-SDK-ENDPOINT' });
appboy.openSession();
```

见 [公众 Github Repo](https://github.com/Appboy/appboy-web-sdk#readme) 用于获取开始的指示或 [我们的文档页面](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/initial_sdk_setup/) 用于基于用途的文档.

## 常见问题

### @braze/web-sdk-core 是什么？

网站和其他JS平台的核心Braze SDK\(无UI\)\.

### 如何安装 @braze/web-sdk-core？

在项目目录运行 npm install @braze/web-sdk-core，或使用 pnpm add / yarn add / bun add。

### @braze/web-sdk-core 支持 TypeScript 吗？

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

### @braze/web-sdk-core 支持 ESM 还是 CommonJS？

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

### @braze/web-sdk-core 可以商用吗？

@braze/web-sdk-core 使用 SEE LICENSE IN https://github\.com/Appboy/appboy-web-sdk/blob/master/LICENSE 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @braze/web-sdk-core 的下载量有多少？

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

### @braze/web-sdk-core 还在维护吗？

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