Skip to main content

sheets (v3)

CRITICAL — 开始前 MUST 先用 Read 工具读取 ../lark-shared/SKILL.md,其中包含认证、权限处理

快速决策

  • 按标题或关键词找云空间里的表格文件,先用 lark-cli docs +search
  • docs +search 会直接返回 SHEET 结果,不要把它误解成只能搜文档 / Wiki。
  • 已知 spreadsheet URL / token 后,再进入 sheets +infosheets +readsheets +find 等对象内部操作。

核心概念

文档类型与 Token

飞书开放平台中,不同类型的文档有不同的 URL 格式和 Token 处理方式。在进行文档操作(如添加评论、下载文件等)时,必须先获取正确的 file_token

文档 URL 格式与 Token 处理

Wiki 链接特殊处理(关键!)

知识库链接(/wiki/TOKEN)背后可能是云文档、电子表格、多维表格等不同类型的文档。不能直接假设 URL 中的 token 就是 file_token,必须先查询实际类型和真实 token。

处理流程

  1. 使用 wiki.spaces.get_node 查询节点信息
  2. 从返回结果中提取关键信息
    • node.obj_type:文档类型(docx/doc/sheet/bitable/slides/file/mindnote)
    • node.obj_token真实的文档 token(用于后续操作)
    • node.title:文档标题
  3. 根据 obj_type 使用对应的 API

查询示例

返回结果示例:

资源关系

操作流程(重要):
  1. create — 创建筛选
    • 用于首次创建筛选
    • ⚠️ range 必须覆盖所有需要筛选的列(如 B1:E200)
    • 如果已有筛选存在,再用 create 会覆盖整个筛选
  2. update — 更新筛选
    • 用于在已有筛选上添加/更新指定列的条件
    • 只需指定 col 和 condition,不需要 range
  3. delete — 删除筛选
  4. get — 获取筛选状态
多列筛选示例: 创建媒体名称(B列)和情感分析(E列)的双重筛选:
常见错误:
  • Wrong Filter Value:筛选已存在,需要先 delete 再 create
  • Excess Limit:update 时重复添加同一列条件

单元格数据类型

接受二维数组的 shortcut(+write/+append--values+create--data)中,每个单元格值支持以下类型。公式、带文本链接、@人、@文档、下拉列表必须使用对象格式,直接传字符串会被当作纯文本存储。 写入公式示例
公式语法参考:涉及 ARRAYFORMULA、原生数组函数、MAP/LAMBDA、日期差、Excel 公式改写等飞书特有规则时,先阅读 references/lark-sheets-formula.md
限制
  • 公式支持 IMPORTRANGE 跨表引用(最多 5 层嵌套、每个工作表最多 100 个引用)
  • @人仅支持同租户用户,单次最多 50 人
  • 下拉列表需先配置下拉选项,否则 multipleValue 写入会变成纯文本。配置方法见 references/lark-sheets-dropdown.md#set-dropdown。值中的字符串不能包含逗号

Shortcuts(推荐优先使用)

Shortcut 是对常用操作的高级封装(lark-cli sheets +<verb> [flags])。有 Shortcut 的操作优先使用。

Spreadsheet Management

对应参考文档:spreadsheet-management

Sheet Management

对应参考文档:sheet-management

Cell Data

对应参考文档:cell-data

Cell Style And Merge

对应参考文档:cell-style-and-merge

Cell Images

对应参考文档:cell-images

Row Column Management

对应参考文档:row-column-management

Filter Views

对应参考文档:filter-views 对应参考文档:dropdown

Float Images

对应参考文档:float-images

Formula

对应参考文档:formula
浮动图片相关的读接口只返回元数据(含 float_image_token),不包含图片字节。要读取图片内容,用 token 调 lark-cli docs +media-preview --token "<float_image_token>" --output ./image.png

API Resources

重要:使用原生 API 时,必须先运行 schema 查看 --data / --params 参数结构,不要猜测字段格式。

spreadsheets

  • create — 创建电子表格
  • get — 获取电子表格信息
  • patch — 修改电子表格属性

spreadsheet.sheet.filters

  • create — 创建筛选
  • delete — 删除筛选
  • get — 获取筛选
  • update — 更新筛选

spreadsheet.sheets

  • find — 查找单元格

spreadsheet.sheet.float_images

  • create — 创建浮动图片
  • patch — 更新浮动图片
  • get — 获取浮动图片
  • query — 查询所有浮动图片
  • delete — 删除浮动图片

权限表