增加保护范围

POST

/sheets/v2/spreadsheets/{spreadsheetToken}/protected_dimension

该接口用于根据 spreadsheetToken 和维度信息增加多个保护范围；单次操作不超过5000行或列。
user_id_type目前默认值为lark_id，2022年1月26日后将会调整默认值为open_id，且不再支持lark_id，请尽快适配！
editors字段已废弃，2022年1月26日后将不再支持editors字段，请使用users作为替代。users为需要增加保护范围编辑权限的用户id，id类型由user_id_type字段决定。

错误码

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

请求参数

Authorization

Bearer Token

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

Query 参数

Body 参数application/json

示例

返回响应

🟢200成功

application/json

Body

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST '/sheets/v2/spreadsheets//protected_dimension?user_id_type=lark_id' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "addProtectedDimension":[
        {
            "dimension":{
                "sheetId":"string",
                "majorDimension":"COLUMNS",
                "startIndex":10,
                "endIndex":13
            },
            "users":[
                "ou_326f4b0552770f2de069deb256de5b30"
            ],
            "lockInfo":"你能编辑"
        }
    ]
}'

响应示例

{
    "code": 0,
    "data": {
        "addProtectedDimension": [
            {
                "dimension": {
                    "endIndex": 0,
                    "majorDimension": "COLUMNS",
                    "sheetId": "***",
                    "startIndex": 0
                },
                "users": [
                    "ou_326f4b0552770f2de069deb256de5b30"
                ],
                "lockInfo": "***",
                "protectId": "***"
            }
        ]
    },
    "msg": "Success"
}

修改于 2025-10-21 06:22:18

更新工作表属性

获取保护范围

增加保护范围

错误码#

请求参数

返回响应

错误码