增加行列

该接口用于在电子表格工作表中增加空白行或列。

使用限制

• 单次调用该接口，最多支持增加 5000 行或列。
• 该接口仅支持在工作表的行末尾或列末尾新增行列。要在指定位置新增行列，你需使用插入行列。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/sheets/v2/spreadsheets/:spreadsheet_token/dimension_range
HTTP Method	POST
接口频率限制	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"

路径参数

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

请求体

名称	类型	必填	描述
dimension	/	是	需要增加行列的维度信息
└ sheetId	string	是	电子表格工作表的 ID。调用获取工作表获取 ID。
└ majorDimension	string	是	更新的维度。可选值： - ROWS：行 - COLUMNS：列
└ length	int	是	要增加的行数或列数。取值范围为 (0,5000]。

请求体示例

{
  "dimension":{
       "sheetId": "2jm6f6",
"majorDimension": "ROWS",
"length": 8
     }
}

cURL 请求示例

curl --location --request POST '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",
"length": 8
     }
}'

响应

响应体

名称	类型	描述
addCount	int	增加的行数或列数
majorDimension	string	增加的表格维度。枚举值： - ROWS：行 - COLUMNS：列

响应体示例

{
    "code": 0,
    "data": {
"addCount": 8,
"majorDimension": "ROWS"
    },
    "msg": "Success"
}

错误码

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