# @corsair-dev/googledocs 中文文档

规范地址：https://npmcn.com/package/%40corsair-dev/googledocs/

版本：0\.1\.5
npm 元数据更新时间：2026-10-01T00:34:11.216Z
中文译文更新时间：2026-11-10T19:42:26.157Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40corsair-dev/googledocs
原文对照：https://npmcn.com/package/%40corsair-dev/googledocs/?lang=original
项目主页：https://docs.corsair.dev/plugins/googledocs
源码仓库：https://github.com/corsairdev/corsair

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

- 包体积（解压后）：183 kB，46 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：zod ^4\.1\.13，corsair \>=0\.1\.120
- 首次发布：2026-07-15T14:19:06.795Z
- 最新版本发布：2026-10-01T00:34:11.046Z
- 近 30 天下载量：11366（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 6 个）

## 中文简介

Corsair 的 Google Docs 插件

## 安装

```sh
npm install @corsair-dev/googledocs
```

也可以使用：`pnpm add @corsair-dev/googledocs`、`yarn add @corsair-dev/googledocs`、`bun add @corsair-dev/googledocs`

## README

# @corsair-dev/googledocs (英语)

Corsair的谷歌 Docs插件. 覆盖文档创建和编辑, 文本操作、文档结构(标题、页脚、脚注、名称) 范围、子弹、表格和基于驱动监视的触发器.

## 认证

该插件使用 **OAuth 2.0 数据** (单位:千美元)`oauth_2`)反对谷歌.

1.  在 [谷歌云控台](https://console.cloud.google.com/) 并启用 **谷歌文档 API** 编辑 **谷歌驱动 API** (驱动权限搜索,导出,复制,以及更改表触发器).
2.  配置 OAuth 同意屏幕并创建 **OAuth 客户端标识** (类型:网络应用程序). 添加您的 Corsair 回调 URL 为 授权重定向 URI .
3.  向 Corsair 提供客户端ID 和秘密; OAuth 流量请求 这些范围:
    -   `https://www.googleapis.com/auth/documents`
    -   `https://www.googleapis.com/auth/drive`
    -   `https://www.googleapis.com/auth/spreadsheets.readonly` (床单读作: `sheets.*` 和图表清单)

访问令牌在到期前自动刷新,请求为 401次重审.

## 终点

跨越这些领域的36个业务:

| 域名 | 业务 |
| --- | --- |
| `documents` | `createDocument`, (中文(简体) ), `createBlankDocument`, (中文(简体) ), `createDocumentMarkdown`, (中文(简体) ), `copyDocument`, (中文(简体) ), `getDocument`, (中文(简体) ), `getDocumentPlaintext`, (中文(简体) ), `updateDocumentMarkdown`, (中文(简体) ), `updateDocumentSectionMarkdown`, (中文(简体) ), `updateDocumentStyle`, (中文(简体) ), `updateExistingDocument`, (中文(简体) ), `updateDocumentBatch`, (中文(简体) ), `exportDocumentAsPdf`, (中文(简体) ), `searchDocuments`, (中文(简体) ), `listSpreadsheetCharts` |
| `sheets` | `readValues` (谢叶API) `spreadsheets.values.get` 通过googledocs OAuth 令牌) |
| `text` | `insertText`, (中文(简体) ), `replaceAllText`, (中文(简体) ), `deleteContentRange`, (中文(简体) ), `insertInlineImage`, (中文(简体) ), `replaceImage`, (中文(简体) ), `insertPageBreak` |
| `structure` | `createHeader`, (中文(简体) ), `createFooter`, (中文(简体) ), `createFootnote`, (中文(简体) ), `createNamedRange`, (中文(简体) ), `createParagraphBullets`, (中文(简体) ), `deleteParagraphBullets`, (中文(简体) ), `deleteHeader`, (中文(简体) ), `deleteFooter`, (中文(简体) ), `deleteNamedRange` |
| `tables` | `insertTable`, (中文(简体) ), `insertTableColumn`, (中文(简体) ), `deleteTableColumn`, (中文(简体) ), `deleteTableRow`, (中文(简体) ), `unmergeTableCells`, (中文(简体) ), `updateTableRowStyle` |

## 触发器( webhooks)

Google Docs没有本地的驱动 API,所以触发骑行 **谷歌驱动器 更改监视频道** 缩小为 Docs mime 类型 。 支持的活动 :

`documentCreated`, (中文(简体) ), `documentUpdated`, (中文(简体) ), `documentDeleted`, (中文(简体) ), `documentAdded`, (中文(简体) ), `documentStructureChanged`, (中文(简体) ), `documentWordCountThreshold`, (中文(简体) ), `documentPlaceholderFilled`, (中文(简体) ), `keywordDetected`, (中文(简体) ), `docChanged`, (中文(简体) ), `folderCreated`

驱动监视频道过期(最大~24h),必须更新. 创建 通过 Drive API 的频道(`changes.watch`)带有频道标识前缀 `googledocs-` ——插件的webhook匹配器要求前缀到 告诉医生除了 `googledrive`{\\fn黑体\\fs22\\bord1\\shad0\\3ahbe\\4ah00\\fscx67\\fscy66\\2chffffff\\3ch808080}那也一样 更改种子。 从存储的页面符中恢复 Webhook 处理器 每次通知.

## 提供商怪异

-   文档编辑经过 `documents.batchUpdate`; 颗粒 结束点(插入/替换/删除文本、页眉、表格.) 内部批量请求.
-   通过将标记下转换为批次更新来标记导入/更新工程 请求 – 复杂的标记下调(已取消的表格,原始 HTML) 纯文本.
-   `exportDocumentAsPdf` 财务报告和审定财务报表 `searchDocuments` 使用驱动器 API,而不是 API医生.
-   Docs API中的索引位置为1个基于UTF-16的相冲 删除操作时不得跨越段边界.

## 常见问题

### @corsair-dev/googledocs 是什么？

Corsair 的 Google Docs 插件

### 如何安装 @corsair-dev/googledocs？

在项目目录运行 npm install @corsair-dev/googledocs，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zod（^4\.1\.13）、corsair（\>=0\.1\.120）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @corsair-dev/googledocs 支持 TypeScript 吗？

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

### @corsair-dev/googledocs 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @corsair-dev/googledocs 可以商用吗？

@corsair-dev/googledocs 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @corsair-dev/googledocs 的下载量有多少？

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

### @corsair-dev/googledocs 还在维护吗？

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