更新行列

该接口用于更新设置电子表格中行列的属性，包括是否隐藏行列和设置行高列宽。

使用限制

单次调用该接口，最多支持设置 5000 行或列。

请求

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

请求头

名称	类型	必填	描述
Authorization	string	是	应用调用 API 时，需要通过访问凭证（access_token）进行身份鉴权，参考选择并获取访问凭证。 值格式："Bearer access_token" 可选值如下： - tenant_access_token： 以应用身份调用 API，可读写的数据范围由应用自身的数据权限范围决定。参考自建应用获取 tenant_access_token或商店应用获取 tenant_access_token。示例值："Bearer t-g1044qeGEDXTB6NDJOGV4JQCYDGHRBARFTGT1234" - user_access_token： 以用户身份调用 API，可读写的数据范围由用户的的数据权限范围决定。参考获取 user_access_token。示例值："Bearer u-cjz1eKCEx289x1TXEiQJqAh5171B4gDHPq00l0GE1234"
Content-Type	string	是	固定值："application/json; charset=utf-8"

路径参数

名称	类型	描述
spreadsheetToken	string	电子表格的 token。可通过以下两种方式获取。了解更多，参考电子表格概述。 - 电子表格的 URL：https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== - 调用获取文件夹中的文件清单

请求体

名称	类型	必填	描述
dimension	/	是	需要更新行列的维度信息
└ sheetId	string	是	工作表的 ID。调用获取工作表获取 ID
└ majorDimension	string	是	更新的维度。可选值： - ROWS：行 - COLUMNS：列
└ startIndex	int	是	要更新的行或列的起始位置。从 1 开始计数。若 startIndex 为 3，则从第 3 行或列开始更新属性。包含第 3 行或列。
└ endIndex	int	是	要更新的行或列结束的位置。从 1 开始计数。若 endIndex 为 7，则更新至第 7 行结束。包含第 7 行。 示例：当 majorDimension为 ROWS、 startIndex 为 3、endIndex 为 7 时，则更新第 3、4、5、6、7 行的属性，共更新 5 行。
dimensionProperties	/	是	更新行或列的属性。至少写入以下参数之一
└ visible	bool	否	是否显示行或列。可选值： - true：显示行或列 - false：隐藏行或列
└ fixedSize	int	否	行高或列宽。单位为像素。fixedSize 为 0 时，等价于隐藏行或列。

请求体示例

{
    "dimension":{
        "sheetId":"2jm6f6",
        "majorDimension":"ROWS",
        "startIndex":1,
        "endIndex":3
    },
    "dimensionProperties":{
        "visible":true,
        "fixedSize":50
    }
}

cURL 请求示例

curl --location --request PUT 'https://open.feishu.cn/open-apis/sheets/v2/spreadsheets/shtcngNygNfuqhxTBf588jwgWbJ/dimension_range' \
--header 'Authorization: Bearer t-e346617a4acfc3a11d4ed24dca0d0c0fc8e0067e' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dimension":{
        "sheetId":"2jm6f6",
        "majorDimension":"ROWS",
        "startIndex":1,
        "endIndex":3
    },
    "dimensionProperties":{
        "visible":true,
        "fixedSize":50
    }
}'

响应

响应体示例

{
    "code": 0,
    "data": {},
    "msg": "Success"
}

错误码

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