获取表格元数据

该接口用于根据 spreadsheetToken 获取表格元数据。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/sheets/v2/spreadsheets/:spreadsheetToken/metainfo
HTTP Method	GET
接口频率限制	100 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	drive:drive 查看、评论、编辑和管理云空间中所有文件 drive:drive:readonly 查看、评论和下载云空间中所有文件 sheets:spreadsheet 查看、评论、编辑和管理电子表格 sheets:spreadsheet:readonly 查看、评论和导出电子表格

请求头

名称	类型	必填	描述
Authorization	string	是	user_access_token 或 tenant_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

路径参数

参数	类型	描述
spreadsheetToken	string	spreadsheet 的 token；获取方式见在线表格开发指南

查询参数

参数	类型	必须	说明
extFields	string	否	额外返回的字段，extFields=protectedRange时返回保护行列信息
user_id_type	string	否	返回的用户id类型，可选open_id,union_id

cURL 请求示例

curl --location --request GET 'https://open.feishu.cn/open-apis/sheets/v2/spreadsheets/shtcngNygNfuqhxTBf588jwgWbJ/metainfo?extFields=protectedRange&user_id_type=open_id' \
--header 'Authorization: Bearer t-e346617a4acfc3a11d4ed24dca0d0c0fc8e0067e'

响应

响应体

参数	类型	说明
spreadsheetToken	string	spreadsheet 的 token
properties		spreadsheet 的属性
∟title	string	spreadsheet 的标题
∟ownerUser	int64	所有者的 id，仅user_id_type为空时返回该值
∟ownerUserID	string	所有者的 id，取决于user_id_type的值，仅user_id_type不为空时返回该值
∟sheetCount	int	spreadsheet 下的 sheet 数
∟revision	int	该 sheet 的版本
sheets	array<interface>	spreadsheet 下的sheet列表
∟sheetId	string	sheet 的 id
∟title	string	sheet 的标题
∟index	int	sheet 的位置
∟rowCount	int	sheet 的最大行数
∟columnCount	int	sheet 的最大列数
∟frozenRowCount	int	该 sheet 的冻结行数，小于等于 sheet 的最大行数，0表示未设置冻结
∟frozenColCount	int	该 sheet 的冻结列数，小于等于 sheet 的最大列数，0表示未设置冻结
∟merges	array<interface>	该 sheet 中合并单元格的范围
∟startRowIndex	int	合并单元格范围的开始行下标，index 从 0 开始
∟startColumnIndex	int	合并单元格范围的开始列下标，index 从 0 开始
∟rowCount	int	合并单元格范围的行数量
∟columnCount	int	合并单元格范围的列数量
∟protectedRange	array<interface>	该 sheet 中保护范围
∟dimension		保护行列的信息，如果为保护工作表，则该字段为空
∟startIndex	int	保护行列的起始位置，位置从1开始
∟endIndex	int	保护行列的结束位置，位置从1开始
∟majorDimension	string	若为ROWS，则为保护行；为COLUMNS，则为保护列
∟sheetId	string	保护范围所在工作表 ID
∟protectId	string	保护范围ID
∟lockInfo	string	保护说明
∟sheetId	string	保护工作表 ID
∟blockInfo		若含有该字段，则此工作表不为表格
∟blockToken	string	block的token
∟blockType	string	block的类型

响应体示例

{
    "code": 0,
    "msg": "Success",
    "data": {
        "properties": {
            "title": "",
            "ownerUser": 0,
            "sheetCount": 0,
            "revision": 0
        },
        "sheets": [
            {
                "sheetId": "***",
                "title": "***",
                "index": 0,
                "rowCount": 0,
                "columnCount": 0,
                "frozenColCount": 0,
                "frozenRowCount": 0,
                "merges": [
                    {
                        "columnCount": 0,
                        "rowCount": 0,
                        "startColumnIndex": 0,
                        "startRowIndex": 0
                    }
                ],
                "protectedRange": [
                    {
                        "dimension": {
                            "endIndex": 0,
                            "majorDimension": "ROWS",
                            "sheetId": "***",
                            "startIndex": 0
                        },
                        "protectId": "***",
                        "sheetId": "***",
                        "lockInfo": "***"
                    }
                ]
            },
            {
                "blockInfo": {
                    "blockToken": "***",
                    "blockType": "***"
                },
                "columnCount": 0,
                "frozenColCount": 0,
                "frozenRowCount": 0,
                "index": 0,
                "rowCount": 0,
                "sheetId": "***",
                "title": "*** "
            }
        ],
        "spreadsheetToken": "***"
    }
}

错误码

具体可参考：服务端错误码说明