编辑表格内容

该接口可以对一个在线表格批量执行多个更新操作。

注意：

1. 批量更新请求中的各个操作会逐个按顺序执行，直到全部执行完成则请求返回，或者其中一个操作报错则不再继续执行后续的操作。
2. 每一个更新操作在执行之前都会做请求校验（包括权限校验、参数校验等等），如果校验未通过则该更新操作会报错并返回，不再执行后续操作。
3. 单次批量更新请求的操作数量 <= 5。

请求方式：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": {}
		}
	]
}

参数说明

权限说明

• 自建应用需配置到“可调用应用”列表中的应用secret所获取的accesstoken来调用（accesstoken如何获取？）
• 第三方应用需具有“文档”权限
• 代开发自建应用需具有“文档”权限

返回示例

{
	"errcode": 0,
	"errmsg": "ok",
	"data": {
		"responses": [
			{
				"add_sheet_response": {}
			},
			{
				"update_range_response": {}
			},
			{
				"delete_dimension_response": {}
			},
			{
				"delete_sheet_response": {}
			}
		]
	}
}

参数说明

参数详细说明

由于请求参数比较复杂，在本节分Object分别说明

UpdateRequest

更新请求，在一个UpdateRequest的Object中只能填一个操作

示例

{
	"add_sheet_request": {}
}

{
	"update_range_request": {}
}

字段说明

AddSheetRequest

新增工作表，新增需满足以下限制：

1. 范围列数 <=200
2. 范围内的总单元格数量 <=10000

示例

{
			"title": "sheet_name",
			"row_count": 10,
			"column_count": 10
}

字段说明

DeleteSheetRequest

删除工作表

示例

{
			"sheet_id": "AAAAA"
}

字段说明

UpdateRangeRequest

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

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

示例

{
			"sheet_id": "AAAAA",
			"grid_data": {}
}

字段说明

DeleteDimensionRequest

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

1. 该操作会导致表格缩表
2. 删除的范围遵循 左闭右开 ———— [start_index,end_index) ，如果 end_index <= start_index 则该请求报错。

示例

{
			"sheet_id": "AAAAA",
			"dimension": "ROW"
}

字段说明

UpdateResponse

更新操作(UpdateRequest])对应的响应结构体类型

示例

{
  "add_sheet_response": {
  },
  "update_range_response": {
  },
  "delete_dimension_response": {
  },
  "delete_sheet_response": {
  }
}

字段说明

AddSheetResponse

新增子表操作的请求响应体结构
示例

{
	"properties": {
	}
}

DeleteSheetResponse

删除工作表请求的相应结构体

示例

{
	"sheet_id": "AABBCC"
}

UpdateRangeResponse

编辑区域内单元格内容请求响应体结构

示例

{
	"updated_cells": 10
}

DeleteDimensionResponse

删除表格连续的行（或列），请求响应体结构
示例

{
	"deleted": 10
}