登录
基础
连接微信
办公目录
该接口可以对一个在线表格批量执行多个更新操作。
注意：
请求方式：POST（HTTPS）
请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/spreadsheet/batch_update?access_token=ACCESS_TOKEN
请求包体
{
"docid": "DOCID",
"requests": [
{
"add_sheet_request": {...}
},
{
"update_range_request": {...}
},
{
"delete_dimension_request": {...}
},
{
"delete_sheet_request": {...}
}
]
}参数说明
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| docid | string | 是 | 文档的docid |
| requests | object[] | 是 | 更新操作列表，详见 UpdateRequest |
权限说明
返回示例
{
"errcode": 0,
"errmsg": "ok",
"data" {
"responses": [
{
"add_sheet_response": {...}
},
{
"update_range_response": {...}
},
{
"delete_dimension_response": {...}
},
{
"delete_sheet_response": {...}
}
]
}
}参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| errcode | int32 | 错误码 |
| errmsg | string | 错误码说明 |
| data.responses | object[] | 结果列表，详见UpdateResponse |
由于请求参数比较复杂，在本节分Object分别说明
更新请求，在一个UpdateRequest的Object中只能填一个操作
示例
{
"add_sheet_request": {...}
}{
"update_range_request": {...}
}字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| add_sheet_request | object(AddSheetRequest) | 新增工作表 |
| delete_sheet_request | object(DeleteSheetRequest | 删除工作表 |
| update_range_request | object(UpdateRangeRequest) | 更新范围内单元格内容 |
| delete_dimension_request | object(DeleteDimensionRequest) | 删除表格连续的行或列 |
新增工作表
示例
{
"title": "sheet_name",
"row_count": 10,
"column_count": 10
}字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| title | string | 工作表名称 |
| row_count | uint32 | 新增工作表的初始行数 |
| column_count | uint32 | 新增工作表的初始列数 |
删除工作表
示例
{
"sheet_id": "AAAAA"
}字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| sheet_id | string | 工作表唯一标识 |
更新范围内单元格内容请求，单次更新的范围大小需满足以下限制：
<=1000 <=200 <=10000示例
{
"sheet_id": "AAAAA",
"grid_data": {...}
}字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| sheet_id | string | 工作表唯一标识 |
| grid_data | object(GridData) | 写入指定区域的数据 |
删除表格连续的行（或列）的请求，注意：
左闭右开 ———— [start_index,end_index) ，如果 end_index <= start_index 则该请求报错。示例
{
"sheet_id": "AAAAA",
"dimension": "ROW"
}字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| sheet_id | string | 工作表唯一标识 |
| dimension | string | 声明删除的维度为行或者列。详见 Dimension |
| start_index | uint32 | 删除行列的起始序号（从1开始） |
| end_index | uint32 | 删除行列的终止序号（从1开始） |
更新操作(UpdateRequest])对应的响应结构体类型
示例
{
"add_sheet_response": {
...
},
"update_range_response": {
...
},
"delete_dimension_response": {
...
},
"delete_sheet_response": {
...
}
}字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| add_sheet_response | object(AddSheetResponse) | 新增工作表响应结构体 |
| delete_sheet_response | object(DeleteSheetResponse | 删除工作表响应结构体 |
| update_range_response | object(UpdateRangeResponse) | 更新范围内单元格内容响应结构体 |
| delete_dimension_response | object(DeleteDimensionResponse) | 删除表格连续的行或列响应结构体 |
新增子表操作的请求响应体结构
示例
{
"properties": {
...
}
}| 参数名 | 数据类型 | 描述 |
|---|---|---|
| properties | object(Properties) | 新增子表的属性 |
删除工作表请求的相应结构体
示例
{
"sheet_id": "AABBCC"
}| 参数名 | 数据类型 | 描述 |
|---|---|---|
| sheet_id | string | 被删除的工作表的唯一标识 |
编辑区域内单元格内容请求响应体结构
示例
{
"updated_cells": 10
}| 参数名 | 数据类型 | 描述 |
|---|---|---|
| updated_cells | uint32 | 数据更新的成功的单元格数量 |
删除表格连续的行（或列），请求响应体结构
示例
{
"deleted": 10
}
| 参数名 | 数据类型 | 描述 |
|---|---|---|
| deleted | integer | 被删除的行数（或列数） |
基础连接微信办公基础连接微信办公基础连接微信办公