# @builder\.io/admin-sdk 中文文档

规范地址：https://npmcn.com/package/%40builder.io/admin-sdk/

版本：0\.0\.9
npm 元数据更新时间：2026-09-09T09:16:10.446Z
中文译文更新时间：2026-11-08T19:03:42.270Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40builder.io/admin-sdk
原文对照：https://npmcn.com/package/%40builder.io/admin-sdk/?lang=original

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

- 包体积（解压后）：136 kB，10 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：11 个
- 首次发布：2021-10-15T19:47:22.188Z
- 最新版本发布：2026-07-27T14:28:42.769Z
- 近 30 天下载量：21305（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：21（近 12 个月 4 个）

## 中文简介

Builder.io 行政API SDK

## 安装

```sh
npm install @builder.io/admin-sdk
```

也可以使用：`pnpm add @builder.io/admin-sdk`、`yarn add @builder.io/admin-sdk`、`bun add @builder.io/admin-sdk`

## README

# Builder.io Admin API SDK 互联网档案馆的存檔,存档日期2013-10-02.

与 Builder.io Graphql Admin API 互动的 Nodejs SDK.

## 如何使用

-   使用您最喜欢的软件包管理器安装 :

```
npm install @builder.io/admin-sdk
```

-   获取您想要管理的空间的私钥 `bpk-xxx`

```typescript
import { createAdminApiClient } from '@builder.io/admin-sdk';
const adminSDK = createAdminApiClient(process.env.BUILDER_PRIVATE_KEY);

// example getting space settings:
const res = await adminSDK.query({
  settings: true,
});

// example getting all models fields on a space:
const res = await adminSDK.query({
  models: {
    id: true,
    fields: true,
  },
});

// example creating a model from admin api
await adminSDK.chain.mutation
  .addModel({
    body: {
      defaultQuery: [],
      kind: 'component',
      showTargeting: true,
      allowHeatmap: true,
      id: 'xxxxxx',
      showMetrics: true,
      publicReadable: true,
      name: 'announcement-bar',
      useQueryParamTargetingClientSide: false,
      fields: [
        {
          type: 'uiBlocks',
          '@type': '@builder.io/core:Field',
          required: true,
          hideFromFieldsEditor: true,
          name: 'blocks',
          showTemplatePicker: true,
        },
      ],
      helperText: 'This model is for announcement bars',
      allowBuiltInComponents: true,
      bigData: false,
      strictPrivateWrite: false,
      requiredTargets: [],
      schema: {},
      examplePageUrl: 'https://my.site.com/preview',
      webhooks: [],
      apiGenerated: true,
      showScheduling: true,
      showAbTests: true,
      pathPrefix: '/',
      componentsOnlyMode: false,
    },
  })
  .execute({});
```

## 更多信息 :

-   检查打开的图解探测器 [建设者.io/api/v2/admin](https://builder.io/api/v2/admin),将您的私钥添加到 http headers 区域,并检查可用的查询/突变 :

![BUILDER](https://cdn.builder.io/api/v1/image/assets%2FYJIGb4i01jvw0SRdL5Bt%2F281068da62e44bb5bce7d48307cec9f0)

## 常见问题

### @builder\.io/admin-sdk 是什么？

Builder\.io 行政API SDK

### 如何安装 @builder\.io/admin-sdk？

在项目目录运行 npm install @builder\.io/admin-sdk，或使用 pnpm add / yarn add / bun add。

### @builder\.io/admin-sdk 支持 TypeScript 吗？

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

### @builder\.io/admin-sdk 支持 ESM 还是 CommonJS？

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

### @builder\.io/admin-sdk 可以商用吗？

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

### @builder\.io/admin-sdk 的下载量有多少？

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

### @builder\.io/admin-sdk 还在维护吗？

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