概述
电子表格概述
支持通过调用表格 API，完成自动创建表格、读取或编辑工作表等操作。
名词解释
表格（Spreadsheet）
表格是承载数据的容器，也提供数据处理和呈现的功能。一个表格可能包含一个或者多个工作表，我们在处理数据时，都是针对某个工作表进行操作的。
每篇文档都有一个 spreadsheetToken 作为唯一标识，每一个工作表都有一个 sheetId 作为唯一标识。
spreadsheetToken 以及 sheetId
spreadsheetToken 是一个表格的唯一标识，你可以通过以下任一方式获取一个表格的 spreadsheetToken：
- 通过表格的 URL 获取：https://sample.feishu.cn/sheets/shtcnmBA*****yGehy8
- 通过 获取文件夹下文档清单 API 的返回值获取表格的 spreadsheetToken
sheetId 是一个工作表的唯一标识，你可以通过以下任一方式获取一个工作表的 sheetId：
- 通过表格的 URL 获取：https://sample.feishu.cn/sheets/shtcnmBA*****yGehy8?sheet=0b**12
- 通过 获取表格元数据 API 的返回值获取工作表的 sheetId
几乎所有的表格操作方法，需要传入 spreadsheetToken 来指定要操作的表格。
Range
Range 描述工作表的某个范围。在数据读写中，能帮助用户过滤数据的操作范围。
range 的描述方式为 !<开始位置>:<结束位置> ，共有 4 种描述方法，分别为：
- !<开始单元格>:<结束单元格>
如：0b12!A1:B5 就表示 0b12 这个工作表中 A1:B5 的区域，如下图所示：
- !<开始列>:<结束列>，如：0b**12!A:B
- !<开始单元格>:<结束列>，如：0b**12!A1:B
- ，区域留空，如：0b**12，代表这个表格中非空的最大行列范围内的数据
在使用「读取单个范围」或「读取多个范围」等读取表格数据的接口时，上述几种描述方式，表示这个工作表中 A1:B5 的区域，如下图所示：
方法集合
表格
包含表格创建、获取和更新相关接口。
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 | ||
|---|---|---|---|---|---|---|
创建表格POST /open-apis/sheets/v3/spreadsheets | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
获取表格元数据GET /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/metainfo | 查看、评论、编辑和管理云空间中所有文件查看、评论和下载云空间中所有文件查看、评论、编辑和管理电子表格查看、评论和导出电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
更新表格属性PUT /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/properties | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ |
工作表
包含工作表操作和更新属性相关接口。
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 | ||
|---|---|---|---|---|---|---|
更新工作表属性POST /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/sheets_batch_update | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
操作工作表POST /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/sheets_batch_update | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ |
工作表 - 条件格式
包含工作表中条件格式创建、删除、获取和更新相关接口。
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 | ||
|---|---|---|---|---|---|---|
创建条件格式POST /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/condition_formats/batch_create | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
获取条件格式GET /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/condition_formats | 查看、评论、编辑和管理云空间中所有文件查看、评论和下载云空间中所有文件查看、评论、编辑和管理电子表格查看、评论和导出电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
更新条件格式POST /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/condition_formats/batch_update | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
删除条件格式DELETE /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/condition_formats/batch_delete | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ |
工作表 - 筛选
包含工作表筛选创建、删除、获取和更新相关接口。
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 | ||
|---|---|---|---|---|---|---|
获取筛选GET /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter | 查看、评论、编辑和管理电子表格查看、评论和导出电子表格查看、评论、编辑和管理云空间中所有文件查看、评论和下载云空间中所有文件 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
创建筛选POST /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter | 查看、评论、编辑和管理电子表格查看、评论、编辑和管理云空间中所有文件 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
更新筛选PUT /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
删除筛选DELETE /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter | 查看、评论、编辑和管理电子表格查看、评论、编辑和管理云空间中所有文件 | tenant_access_tokenuser_access_token | ✓ | ✓ |
工作表 - 筛选视图
包含工作表筛选视图创建、删除、获取和更新相关接口。
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 | ||
|---|---|---|---|---|---|---|
删除筛选视图DELETE /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter_views/:filter_view_id | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
更新筛选视图PATCH /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter_views/:filter_view_id | 查看、评论、编辑和管理电子表格查看、评论、编辑和管理云空间中所有文件 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
查询筛选视图GET /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter_views/query | 查看、评论和导出电子表格查看、评论、编辑和管理云空间中所有文件查看、评论和下载云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
获取筛选视图GET /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter_views/:filter_view_id | 查看、评论、编辑和管理电子表格查看、评论和导出电子表格查看、评论、编辑和管理云空间中所有文件查看、评论和下载云空间中所有文件 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
创建筛选视图POST /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter_views | 查看、评论、编辑和管理电子表格查看、评论、编辑和管理云空间中所有文件 | tenant_access_tokenuser_access_token | ✓ | ✓ |
筛选视图 - 筛选条件
包含筛选视图的筛选条件创建、删除、获取、更新和查询相关接口。
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 | ||
|---|---|---|---|---|---|---|
删除筛选条件DELETE /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter_views/:filter_view_id/conditions/:condition_id | 查看、评论、编辑和管理电子表格查看、评论、编辑和管理云空间中所有文件 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
更新筛选条件PUT /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter_views/:filter_view_id/conditions/:condition_id | 查看、评论、编辑和管理电子表格查看、评论、编辑和管理云空间中所有文件 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
查询筛选条件GET /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter_views/:filter_view_id/conditions/query | 查看、评论、编辑和管理电子表格查看、评论和导出电子表格查看、评论、编辑和管理云空间中所有文件查看、评论和下载云空间中所有文件 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
获取筛选条件GET /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter_views/:filter_view_id/conditions/:condition_id | 查看、评论和下载云空间中所有文件查看、评论、编辑和管理电子表格查看、评论和导出电子表格查看、评论、编辑和管理云空间中所有文件 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
创建筛选条件POST /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter_views/:filter_view_id/conditions | 查看、评论、编辑和管理电子表格查看、评论、编辑和管理云空间中所有文件 | tenant_access_tokenuser_access_token | ✓ | ✓ |
工作表 - 行列
包含工作表行列增加、插入、删除、移动和更新相关接口。
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 | ||
|---|---|---|---|---|---|---|
删除行列DELETE /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/dimension_range | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
更新行列PUT /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/dimension_range | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
增加行列POST /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/dimension_range | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
插入行列POST /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/insert_dimension_range | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
移动行列POST /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/move_dimension | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ |
行列 - 保护范围
包含行列的保护范围增加、删除、获取和修改相关接口。
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 | ||
|---|---|---|---|---|---|---|
增加保护范围POST /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/protected_dimension | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
获取保护范围GET /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/protected_range_batch_get | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
修改保护范围POST /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/protected_range_batch_update | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
删除保护范围DELETE /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/protected_range_batch_del | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ |
工作表 - 数据
包含工作表中单元格数据写入与读取，插入图片，样式设置，单元格合并与拆分，内容查找和替换相关接口。
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 | ||
|---|---|---|---|---|---|---|
插入数据POST /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/values_prepend | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
追加数据POST /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/values_append | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
读取单个范围GET /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/values/:range | 查看、评论、编辑和管理云空间中所有文件查看、评论和下载云空间中所有文件查看、评论、编辑和管理电子表格查看、评论和导出电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
读取多个范围GET /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/values_batch_get | 查看、评论、编辑和管理云空间中所有文件查看、评论和下载云空间中所有文件查看、评论、编辑和管理电子表格查看、评论和导出电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
向单个范围写入数据PUT /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/values | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
向多个范围写入数据POST /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/values_batch_update | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
设置单元格样式PUT /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/style | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
批量设置单元格样式PUT /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/styles_batch_update | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
合并单元格POST /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/merge_cells | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
拆分单元格POST /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/unmerge_cells | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
写入图片POST /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/values_image | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
查找单元格POST /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/find | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格查看、评论和下载云空间中所有文件查看、评论和导出电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
替换单元格POST /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/replace | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ |
工作表 - 浮动图片
包含工作表浮动图片创建、删除、查询、获取和更新相关接口。
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 | ||
|---|---|---|---|---|---|---|
创建浮动图片POST /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/float_images | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
获取浮动图片GET /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/float_images/:float_image_id | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格查看、评论和下载云空间中所有文件查看、评论和导出电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
查询浮动图片GET /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/float_images/query | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格查看、评论和下载云空间中所有文件查看、评论和导出电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
更新浮动图片PATCH /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/float_images/:float_image_id | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
删除浮动图片DELETE /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/float_images/:float_image_id | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ |
工作表 - 数据校验
包含工作表数据验证设置、删除、查询和更新相关接口。
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 | ||
|---|---|---|---|---|---|---|
设置下拉列表POST /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/dataValidation | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
删除下拉列表设置DELETE /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/dataValidation | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
更新下拉列表设置PUT /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/dataValidation/:sheetId/:dataValidationId | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
查询下拉列表设置GET /open-apis/sheets/v2/spreadsheets/:spreadsheetToken/dataValidation | 查看、评论、编辑和管理云空间中所有文件查看、评论、编辑和管理电子表格 | tenant_access_tokenuser_access_token | ✓ | ✓ |
扫码加入交流群修改于 2023-01-13 09:50:23