Request

... 2022-10-14 大约 2 分钟

# Request

参数说明： 在线表格（spreadsheet）更新操作的请求类型

{
  // 下列字段只能填写其中一个，若填写多个则排序优先的字段生效，其余字段无效
  "addSheetRequest": {
    Object(AddSheetRequest)
  },
  "updateRangeRequest": {
    Object(UpdateRangeRequest)
  },
  "deleteDimensionRequest": {
    Object(DeleteDimensionRequest)
  },
  "deleteSheetRequest": {
    Object(DeleteSheetRequest)
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# AddSheetRequest

新增工作表操作请求，请求参数如下：

参数名称	数据类型	必填	描述
title	string	是	工作表名称，长度限制31个字符
rowCount	integer	否	新增工作表的初始行数，该值传空则取默认值：`200`
columnCount	integer	否	新增工作表的初始列数，该值传空则取默认值： `20`

新增工作表的大小必须满足如下限制：

行数 <=10000
列数 <=200
单元格总数 10000

# UpdateRangeRequest

更新范围内单元格内容请求，单次更新的范围大小需满足以下限制：

范围行数 <=1000
范围列数 <=200
范围内的总单元格数量 <=10000

参数如下：

参数名称	数据类型	必填	描述
sheetId	string	是	工作表唯一标识
gridData	object(GridData)	是	写入指定区域的数据

补充说明：

目前单元格支持的数据类型（CellValue）只包括：text、link、number

示例

{
  "requests": [
    {
      "updateRangeRequest": {
        "sheetId": "BB08J2",
        "gridData": {
          "startRow": 1,
          "startColumn": 6,
          "rows": [
            {
              "values": [
                {
                  "cellValue": {
                    "text": "123"
                  },
                  "cellFormat": {
                    "textFormat": {
                      "fontSize": 12,
                      "bold": true
                    }
                  }
                },
                {
                  "cellValue": {
                    "text": "test"
                  },
                  "cellFormat": {
                    "textFormat": {
                      "fontSize": 20,
                      "bold": true,
                      "underline": true,
                      "italic": true,
                      "color": {
                        "red": 255,
                        "green": 100
                      }
                    }
                  }
                },
                {
                  "cellValue": {
                    "text": "test123"
                  },
                  "cellFormat": {
                    "textFormat": {
                      "bold": true,
                      "underline": true,
                      "italic": true,
                      "color": {
                        "red": 255
                      }
                    }
                  }
                },
                {
                  "cellValue": {
                    "link": {
                      "url": "docs.qq.com",
                      "text": "超链接"
                    }
                  }
                }
              ]
            }
          ]
        }
      }
    }
  ]
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

# DeleteDimensionRequest

删除表格连续的行（或列）的请求，注意：

该操作会导致表格缩表
删除的范围遵循左闭右开 ———— [startIndex,endIndex)，如果 end <= start 则该请求报错。
删除行列时，不能将行列全部删除，至少保留一行（列）。如需清除工作表，可以考虑使用下方的 DeleteSheetRequest，删除工作表。

参数名	数据类型	必填	描述
sheetId	string	是	工作表唯一标识
dimension	string	是	声明删除的维度为行或者列。参考 Dimension
startIndex	integer	是	删除行列的起始序号（从1开始）
endIndex	integer	是	删除行列的终止序号（从1开始）

# DeleteSheetRequest

删除工作表请求：

参数名	数据类型	必填	描述
sheetId	string	是	工作表唯一标识