gws-keep 是 Google Workspace CLI(gws)中面向 Google Keep 的命令模块,版本为 v1,用于在命令行中管理 Google Keep 笔记。
用途 该模块让用户通过 gws 命令行工具对 Google Keep 的笔记资源进行操作,包括创建、删除、获取和列出笔记,以及下载笔记附件,并支持对笔记权限资源执行相关操作。
前置条件 使用前需要先阅读共享技能文档 ../gws-shared/SKILL.md,其中包含认证方式、全局参数与安全规则。如果该文档缺失,可运行 gws generate-skills 来生成。
命令形式 基本调用形式为:gws keep <resource> <method> [flags]。
主要能力(API 资源与方法)
- media(媒体)
- download:获取附件。通过 REST 下载附件媒体需要 alt=media 查询参数。如果请求的 MIME 类型下附件媒体不可用,会返回 400 bad request 错误。
- notes(笔记)
- create:创建一条新笔记。
- delete:删除一条笔记。调用者必须对笔记拥有 OWNER 角色才能删除。删除笔记会立即移除该资源且无法撤销,所有协作者将失去对该笔记的访问权限。
- get:获取一条笔记。
- list:列出笔记。每次 list 调用返回一页结果,page_size 为返回条目的上限;page_size 为 0 时由服务器决定上限。ListNotesResponse 最多包含 page_size 个条目。如果还有更多内容待列出,会提供 next_page_token 值(分页令牌为不透明值)。要获取下一页结果,将结果中的 next_page_token 复制到下一次请求的 page_token 中。
- permissions(权限)
- 对 'permissions' 资源执行的操作。
使用方式 在调用任何 API 方法之前,建议先检查该方法:
- 浏览资源与方法:gws keep --help
- 查看某个方法的必填参数、类型与默认值:gws schema keep.<resource>.<method> 使用 gws schema 的输出可以构建 --params 和 --json 参数。
适用场景 适用于需要在命令行或自动化脚本中管理 Google Keep 笔记的场景,例如批量创建笔记、查询笔记列表、获取单条笔记内容、下载附件,以及在具备 OWNER 权限时删除笔记。
限制
- 删除笔记不可撤销,且需要 OWNER 角色。
- 附件下载需要 alt=media 查询参数,且受 MIME 类型可用性限制,不可用时返回 400 错误。
- 列表接口采用分页机制,需通过 page_token 与 next_page_token 逐页获取。
- 使用前必须完成认证配置并遵循共享文档中的安全规则。
关于收费、价格、平台支持范围等更多信息,资料中暂未提供。