目录
本接口用于获取指定范围内的在线表格信息,单次查询的范围大小需满足以下限制:
<=1000
<=200
<=10000
请求方式:POST(HTTPS)
请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/spreadsheet/get_sheet_range_data?access_token=ACCESS_TOKEN
请求包体
{
"docid": "DOCID",
"sheet_id": "AABBCC",
"range": "A1:B2"
}
参数说明
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
docid | string | 是 | 在线表格唯一标识 |
sheet_id | string | 是 | 工作表ID,工作表的唯一标识 |
range | string | 是 | 查询的范围,格式遵循 A1表示法 |
权限说明
返回示例
{
"errcode": 0,
"errmsg": "ok",
"data": {
"result": {
}
}
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 错误码 |
errmsg | string | 错误码说明 |
data.result | object(GridData) | 表格数据 |
由于返回结果比较复杂,在本节分Object分别说明
GridData定义了表格的具体数据内容
示例
{
"start_row": 1,
"start_column": 1,
"rows": [
{}, {}
]
}
字段名 | 类型 | 描述 |
---|---|---|
start_row | uint32 | 起始行编号 (从0开始计算) |
start_column | uint32 | 起始列编号 (从0开始计算) |
rows | object[](RowData) | 各行的数据 |
行数据的资源描述
示例
{
"values": [
{}, {}
]
}
字段名 | 数据类型 | 描述 |
---|---|---|
values | object[](CellData) | 各个单元格的数据内容 |
单元格的信息
示例
{
"cell_value": {},
"cell_format": {}
}
字段名 | 数据类型 | 描述 |
---|---|---|
cell_value | object(CellValue) | 单元格的数据内容 |
cell_format | object(CellFormat) | 单元格的样式信息 |
单元格的数据内容,暂时只支持文本、链接,一个CellValue中只能选填一个字段
示例
{
"text": "hello world"
}
{
"link": {
"text": "hello world",
"url": "http://xxxx.com"
}
}
字段名 | 数据类型 | 描述 |
---|---|---|
text | string | 文本内容 |
link | object(Link) | 超链接内容 |
单元格的样式信息
示例
{
"text_format": {}
}
字段名 | 数据类型 | 描述 |
---|---|---|
text_format | object(TextFormat) | 文字样式 |
文本样式信息
示例
{
"font": "Courier New",
"font_size": 14,
"bold": false,
"italic": false,
"strikethrough": false,
"underline": false,
"color": {}
}
字段名 | 数据类型 | 描述 |
---|---|---|
font | string | 字体名称,表格支持的字体类型: 字体列表 |
font_size | uint32 | 字体大小,最大72 |
bold | bool | 字体加粗 |
italic | bool | 斜体 |
strikethrough | bool | 字体删除线 |
underline | bool | 下划线 |
color | object(Color) | 字体颜色 |
颜色信息,采用 RGBA
表示法
示例
{
"red": 0,
"green": 0,
"blue": 255,
"alpha": 255
}
字段名 | 数据类型 | 描述 |
---|---|---|
red | uint32 | 红色,取值范围:[0,255] |
green | uint32 | 绿色,取值范围:[0,255] |
blue | uint32 | 蓝色,取值范围:[0,255] |
alpha | uint32 | alpha通道,取值范围:[0,255],默认值为255完全不透明 |
超链接的相关信息
示例
{
"url": "https://xxxx",
"text": "Website"
}
字段名 | 数据类型 | 描述 |
---|---|---|
url | string | 链接url |
text | string | 链接标题 |
声明维度属性为行或者列的字符串枚举值
枚举值 | 含义 |
---|---|
ROW | 行 |
COLUMN | 列 |
A1 表示法
是比较常见的范围表格数据引用的表示方法,可以表示一个左上角坐标到右下角坐标之间的连续区域。示例:
表达式 | 含义 |
---|---|
A1:A1 | 表示一个单元格 A1 |
A1:B5 | 从单元格 A1 到单元格 B5 的区域 |
A1:D1 | 第一行的4个单元格,分别为 A1 、 B1 、 C1 、 D1 |
A1:A3 | 第一列的3个单元格,分别为 A1 、 A2 、 A3 |
B5:A1 | 不合法的表示,因为 B5 在 A1 的右下方。 |
在线表格api支持开发者设置单元格内的字体,以下是可供选择的字体列表: