获取表格数据

开发者中心

首页

教程

接口

社区

工具

企业内部开发

快速入门服务端API 客户端API 附录更新日志联系我们

企业内部开发服务端API 文档获取文档数据获取表格数据

获取表格数据

最后更新：2023/01/06

获取表格数据

参数详细说明

GridData

RowData

CellData

CellValue

CellFormat

TextFormat

Color

Link

Dimension

其他

A1表示法

字体列表

本接口用于获取指定范围内的在线表格信息，单次查询的范围大小需满足以下限制：

查询范围行数 <=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表示法

权限说明

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

返回示例

{
	"errcode": 0,
	"errmsg": "ok",
	"data": {
		"result": {
			...
		}
	}
}

参数说明

参数	类型	说明
errcode	int32	错误码
errmsg	string	错误码说明
data.result	object(GridData)	表格数据

参数详细说明

由于返回结果比较复杂，在本节分Object分别说明

GridData

GridData定义了表格的具体数据内容

示例

{
	"start_row": 1,
	"start_column": 1,
	"rows": [
		{...}, {...}...
	]
}

字段名	类型	描述
start_row	uint32	起始行编号（从0开始计算）
start_column	uint32	起始列编号（从0开始计算）
rows	object[](RowData)	各行的数据

RowData

行数据的资源描述

示例

{
	"values": [
		{...}, {...}...
	]
}

字段名	数据类型	描述
values	object[](CellData)	各个单元格的数据内容

CellData

单元格的信息

示例

{
	"cell_value": {...},
	"cell_format": {...}
}

字段名	数据类型	描述
cell_value	object(CellValue)	单元格的数据内容
cell_format	object(CellFormat)	单元格的样式信息

CellValue

单元格的数据内容，暂时只支持文本、链接，一个CellValue中只能选填一个字段

示例

{
		"text": "hello world"
}

{
	"link": {
		"text": "hello world",
		"url": "http://xxxx.com"
	}
}

字段名	数据类型	描述
text	string	文本内容
link	object(Link)	超链接内容

CellFormat

单元格的样式信息

示例

{
	"text_format": {...}
}

字段名	数据类型	描述
text_format	object(TextFormat)	文字样式

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)	字体颜色

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完全不透明

Link

超链接的相关信息

示例

{
	"url": "https://xxxx",
	"text": "Website"
}

字段名	数据类型	描述
url	string	链接url
text	string	链接标题

Dimension

声明维度属性为行或者列的字符串枚举值

枚举值	含义
ROW	行
COLUMN	列

其他

A1表示法

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支持开发者设置单元格内的字体，以下是可供选择的字体列表：

Microsoft YaHei
SimSun
SimHei
FangSong
KaiTi
DFKai-SB
STFangsong
STKaiti
STSong
NSimSun
Microsoft JhengHei
PMingLiU
Arial
Times New Roman
Calibri
Comic Sans MS
Courier New
Georgia
Microsoft Uighur
Impact
Trebuchet MS
Verdana
Aharoni
Andalus
AngsanaUPC
Angsana New
Aparajita
Arabic Typesetting
Arial Black
Arial Narrow
Batang
BatangChe
Bookman Old Style
Book Antiqua
Bradley Hand ITC
BrowalliaUPC
Browallia New
Cambria
Cambria Math
Candara
Century
Century Gothic
Consolas
Constantia
Corbel
CordiaUPC
Cordia New
DaunPenh
David
DilleniaUPC
DokChampa
Dotum
DotumChe
Ebrima
Estrangelo Edessa
EucrosiaUPC
Euphemia
Franklin Gothic
Franklin Gothic Medium
FrankRuehl
FreesiaUPC
Freestyle Script
French Script MT
Gabriola
Gadugi
Garamond
Gisha
Gulim
GulimChe
Gungsuh
GungsuhChe
Haettenschweiler
IrisUPC
Iskoola Pota
JasmineUPC
Juice ITC
Kalinga
Kartika
Khmer UI
KodchiangUPC
Kokila
Kristen ITC
Lao UI
Latha
Leelawadee
Levenim MT
LilyUPC
Lucida Console
Lucida Handwriting
Lucida Sans Unicode
Malgun Gothic
Mangal
Marlett
Meiryo
Meiryo UI
Microsoft Himalaya
Microsoft JhengHei UI
Microsoft JhengHei UI Light
Microsoft New Tai Lue
Microsoft PhagsPa
Microsoft Sans Serif
Microsoft Tai Le
Microsoft YaHei UI
Microsoft YaHei UI Light
Microsoft Yi Baiti
MingLiU-ExtB
MingLiU_HKSCS-ExtB
MingLiU_HKSCS
Miriam
Miriam Fixed
Mistral
Mongolian Baiti
Monotype.com
Monotype Corsiva
MoolBoran
MS Gothic
MS Mincho
MS Outlook
MS PGothic
MS PMincho
MS UI Gothic
MT Extra
MV Boli
Narkisim
Nirmala UI
Nyala
Palatino Linotype
Papyrus
Plantagenet Cherokee
PMingLiU-ExtB
Pristina
Raavi
Rod
Sakkal Majalla
Segoe Print
Segoe Script
Segoe UI Symbol
Shonar Bangla
Shruti
Simplified Arabic Fixed
Sylfaen
Symbol
Tahoma
Tempus Sans ITC
Traditional Arabic
Tunga
Utsaah
Vani
Vijaya
Vrinda
Webdings
Wingdings

获取表格行列信息

概述

本节内容

获取表格数据
参数详细说明
GridData
RowData
CellData
CellValue
CellFormat
TextFormat
Color
Link
Dimension
其他
A1表示法
字体列表