gpsread Google 表格保护工作表并发出警告

Question

我正在尝试使用gspread库来保护工作表并警告用户是否要进行更改，即使他们是编辑者也是如此。

在 Google 表格中，这称为“编辑此范围时显示警告”

gpsread 在这里有一个 function add_protected_range 。 通过 gpsread 我运行worksheet.add_protected_range('A1:J10', warning_only=True)并且出现错误

gspread.exceptions.APIError: {'code': 400, 'message': 'Invalid requests[0].addProtectedRange: ProtectedRange is warningOnly. 无法对其设置编辑器。', 'status': 'INVALID_ARGUMENT'}

删除warning_only返回任何错误，但编辑器仍然可以编辑，这不是我的目标。

我如何让它工作？

此外，此 function 仅用于保护范围。 有没有办法使整个工作表受到保护？

Answer 1

我相信你的目标如下。

• 问题 1：您想在用户编辑工作表中A1:J10的单元格时显示警告。 当用户编辑受保护范围内的单元格时，您希望显示警告屏幕。
• 问题 2：您想保护工作表而不是范围。 当用户编辑受保护工作表中的单元格时，您希望显示警告屏幕。

问题1的答案：

当warningOnly为true时，不能使用editors的属性。 但是，当我看到脚本add_protected_range时，似乎包含了默认编辑器。 Ref我认为通过这个，会发生这样的错误。 那么这种情况下，为了避免这种情况，直接使用batchUpdate方法怎么样呢？ 示例脚本如下。

示例脚本：

spreadsheetId = "###" # Please set the Spreadsheet ID.
sheetName = "Sheet1" # Please set the sheet name.

client = gspread.authorize(credentials)
ss = client.open_by_key(spreadsheetId)
sheetId = ss.worksheet(sheetName)._properties['sheetId']
request_body = {
    "requests": [
        {
            "addProtectedRange": {
                "protectedRange": {
                    "range": {
                        "sheetId": sheetId,
                        "startRowIndex": 0,
                        "endRowIndex": 10,
                        "startColumnIndex": 0,
                        "endColumnIndex": 10
                    },
                    "warningOnly": True
                }
            }
        }
    ]
}
res = ss.batch_update(request_body)

• 运行上述脚本时，“Sheet1”的“A1:J10”单元格受到保护。 当用户编辑受保护范围内的单元格时，会打开警告屏幕。

问题2的答案：

同样在这种情况下，直接使用 batchUpdate 方法怎么样？ 示例脚本如下。

示例脚本：

spreadsheetId = "###" # Please set the Spreadsheet ID.
sheetName = "Sheet1" # Please set the sheet name.

client = gspread.authorize(credentials)
ss = client.open_by_key(spreadsheetId)
sheetId = ss.worksheet(sheetName)._properties['sheetId']
request_body = {
    "requests": [
        {
            "addProtectedRange": {
                "protectedRange": {
                    "range": {
                        "sheetId": sheetId,
                    },
                    "warningOnly": True
                }
            }
        }
    ]
}
res = ss.batch_update(request_body)

• 运行上述脚本时，“Sheet1”工作表受到保护。 当用户编辑“Sheet1”中的单元格时，会打开警告屏幕。

参考：

• gspread 的模型.py
• batch_update（正文）
• 保护范围