插入行列

该接口用于在电子表格的指定位置插入空白行或列。

使用限制

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

请求

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

请求头

名称	类型	必填	描述
Authorization	string	是	通过访问凭证（access_token）对调用者身份进行鉴权。可选值： - tenant_access_token： 租户授权凭证。应用代表租户（即企业或团队）执行对应操作。示例值："Bearer t-7f1bcd13fc57d46bac21793aabcef" - user_access_token：用户授权凭证。应用代表用户执行对应操作。示例值："Bearer u-7f1bcd13fc57d46bac21793aabcef" 了解更多，参考获取访问凭证。
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	是	插入的行或列的起始位置。从 0 开始计数。若 startIndex 为 3，则从第 4 行或列开始插入空行或列。包含第 4 行或列。
∟endIndex	int	是	插入的行或列结束的位置。从 0 开始计数。若 endIndex 为 7，则从第 8 行结束插入行。第 8 行不再插入空行。 示例：当 majorDimension为 ROWS、 startIndex 为 3、endIndex 为 7 时，则在第 4、5、6、7 行插入空白行，共插入 4 行。
inheritStyle	string	否	插入的空白行或列是否继承表中的单元格样式。不填或设置为空即不继承任何样式，为默认空白样式。可选值： - BEFORE：继承起始位置的单元格的样式 - AFTER：继承结束位置的单元格的样式

请求体示例

{
    "dimension":{
        "sheetId":"2jm6f6",
        "majorDimension":"ROWS",
        "startIndex":3,
        "endIndex":7
    },
    "inheritStyle":"BEFORE"
}

cURL 请求示例

curl --location --request POST 'https://open.feishu.cn/open-apis/sheets/v2/spreadsheets/shtcngNygNfuqhxTBf588jwgWbJ/insert_dimension_range' \
--header 'Authorization: Bearer t-e346617a4acfc3a11d4ed24dca0d0c0fc8e0067e' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dimension":{
        "sheetId":"2jm6f6",
        "majorDimension":"ROWS",
        "startIndex":3,
        "endIndex":7
    },
    "inheritStyle":"BEFORE"
}'

响应

响应体示例

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

错误码

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