开放概览
钉钉表格 提供了丰富的开放API,开发者可自行根据业务进行选择。工作表
行列
| API | API说明 | API版本 |
|---|---|---|
| 删除行 | 删除指定的行。 | 新版 |
| 删除列 | 删除指定的列。 | 新版 |
| 设置自动行高 | 可根据指定的字体大小自动调整钉钉表格中指定行的行高,使内容完整显示。 | 新版 |
| 批量设置列宽 | 一次性设置钉钉表格中从指定列开始的连续多列的宽度。 | 新版 |
| 批量设置行高 | 一次性设置钉钉表格中从指定行开始的连续多行的高度。 | 新版 |
| 工作表中追加行 | 在工作表的已有数据末尾追加若干行数据。 | 新版 |
| 设置行隐藏或显示 | 设置行隐藏或者正常显示。 | 新版 |
| 设置列隐藏或显示 | 设置列隐藏或者正常显示。 | 新版 |
| 指定行上方插入若干行 | 在指定的行上方插入若干行。 | 新版 |
| 指定列左侧插入若干列 | 在指定列左侧插入若干列。 | 新版 |
单元格区域
| API | API说明 | API版本 |
|---|---|---|
| 合并单元格 | 将钉钉表格中指定区域内的多个单元格合并为一个整体。 | 新版 |
| 插入下拉列表 | 为钉钉表格中指定单元格区域设置下拉列表选项。 | 新版 |
| 删除下拉列表 | 移除钉钉表格中指定单元格区域上已设置的下拉列表配置。 | 新版 |
| 获取单元格区域 | 获取单元格属性。 | 新版 |
| 更新单元格区域 | 更新单元格信息。 | 新版 |
| 查找工作表中的单元格 | 根据指定的条件查找匹配给定字符串的下一个单元格。 | 新版 |
| 查找所有符合条件的单元格 | 在指定工作表中搜索包含目标文本的单元格,并返回匹配单元格的位置列表。 | 新版 |
| 清除单元格区域内数据 | 清除单元格区域内数据,不包括格式。 | 新版 |
| 清除单元格区域内所有内容 | 清除单元格区域内所有内容,包括格式。 | 新版 |
条件格式
| API | API说明 | API版本 |
|---|---|---|
| 创建条件格式规则 | 在钉钉表格的指定工作表中创建条件格式规则。 | 新版 |
筛选
筛选试图
浮动图片
名词解释
workbookId
表格文件的唯一标识。即知识库 API 返回的nodeId(dentryUuid),也可以从表格 URL 中获取。获取方式如下:
-
方式一:从表格 URL 中获取。
-
方式二:从文档信息中获取。
-
方式三:通过知识库 API 获取。
调用获取节点或创建知识库文档接口,返回的
nodeId(dentryUuid)即为workbookId。
sheetId
工作表的 ID 或名称。可通过获取所有工作表接口获取,也可以直接传工作表标题。rangeAddress
单元格范围地址,使用 A1 表示法。operatorId
操作人的unionId,用于标识执行操作的用户身份和权限校验。