1. 文件-表格文件(Excel) API
石墨文档中台-开发文档
  • 1. 适用范围
  • 00. 概述
    • 石墨文档中台能做什么?
    • 三种典型的业务接入场景
    • 石墨文档中台支持哪些格式?
  • 01. 快速开始
    • 基本概念
    • 场景一:10 分钟创建预览文件
    • 场景二:10 分钟创建协同编辑文件
  • 02. 鉴权与安全
    • 整体概述
    • 签名凭证 Token
    • 签名凭证 Signature
  • 03. 文件预览
    • 整体概述
    • 如何预热预览缓存
    • 如何防盗链
    • 常见问题处理
  • 04. 文件编辑
    • 整体概述
    • 协同文档权限设计
    • 协同文件保存与更新机制
    • 协同文件复制与删除
  • 05. 文件导入导出
    • 整体概述
    • 常见问题处理
  • 06. 石墨前端 API
    • 整体概述
    • 公共 API
      • 公共处理方法
      • 顶部栏定制 HeaderBars
    • 编辑器 API
      • 轻文档
      • 传统文档
      • 表格
      • 幻灯片
      • 表单
      • 应用表格
  • 07. 石墨后端 API
    • 整体概述
    • 错误码说明
    • 文件-预览 API
      • 访问预览文件
      • 创建文件预览缓存
    • 文件-协同编辑文件管理 API
      • 访问协同编辑文件
      • 创建协同文件
      • 创建协同文件副本
      • 删除协同文件
    • 文件-导入导出 API
      • 文件导入
        • 文件导入说明
        • 创建导入任务
        • 获取导入进度
        • 创建导入任务(旧版)
        • 获取导入进度(旧版)
      • 文件导出
        • 文件导出流程
        • 创建导出任务
        • 获取导出进度
    • 文件-表格文件(Excel) API
      • 表格接口参数说明
      • 获取表格内容
        GET
      • 获取表格中的评论数
        GET
      • 更新表格内容
        POST
      • 追加表格内容
        PUT
      • 删除表格行
        DELETE
      • 新增表格工作表
        POST
    • 文件-文稿文件(Word) API
      • 文稿书签说明
      • 读取文稿书签内容
      • 替换文稿书签内容
    • 文件-文档文件(类 Markdown) API
      • 获取文档中的评论列表
    • 文件-应用表格文件(多维表格)API
      • 应用表格列及单元格值结构
      • 应用表格接口调用规则
      • 获取数据表列表
      • 创建数据表
      • 获取字段列表
      • 创建字段
      • 更新字段
      • 删除字段
      • 新增行
      • 获取单行
      • 更新行
      • 删除行
    • 文件-获取额外信息 API
      • 获取文件的纯文本内容
      • 文件纯文本字数统计
      • 获取文件的历史列表
      • 获取文件的版本列表
      • 获取文件内容中所有的 @ 人信息列表
      • 还原文件历史版本
    • 系统管理 API
      • 应用管理
        • 获取应用详情
        • 更新应用回调地址
      • 用户席位管理
        • 用户席位状态说明
        • 获取用户列表和席位状态
        • 激活用户席位​
        • 取消用户席位​
        • 批量设置用户席位
    • 其他 API
      • 上报事件
      • 创建行为历史
      • 推送文件内全部的用户
      • 推送用户全部的 websocket 连接
    • 获取行列表
      GET
  • 08. 回调接口(你的应用需实现的接口)
    • 整体概述
    • 文件信息
      • 文件权限说明
      • [重要] 获取文件元信息-协同文档
      • [重要] 获取文件元信息-预览文档
      • 获取当前用户的文件列表
      • 获取文件的协作者列表
      • 获取接入方指定文件的完整访问地址
      • 获取文件元信息-协同文档自动任务(admin)
      • 根据指定用户获取文件元信息-协同文档(admin)
    • 用户信息
      • 批量获取用户信息(admin)
      • [重要] 获取当前用户信息
      • 获取当前用户所在团队信息
      • 获取指定用户信息
      • 获取用户水印信息
      • 获取用户部门路径
      • 批量获取用户信息
    • 团队和部门
      • 特殊部门 ID 说明
      • 获取团队下的成员列表
      • 获取部门信息
      • 获取部门的下级部门节点
      • 获取部门下的成员分页列表
    • 搜索功能
      • 获取与文件相关的用户列表
      • 获取与文件相关的文件列表
      • 按关键字搜索文件和用户列表
    • 事件推送
      • 整体概述
      • 评论(Comment)
        • 轻文档
          • 添加评论
          • 删除评论
          • 结束评论
          • 对于评论的回复评论
        • 表格
          • 添加评论
          • 删除评论
          • 结束评论
          • 对于评论的回复评论
        • 传统文档
          • 对于评论的回复评论
          • 添加评论
          • 更新评论
          • 删除评论
        • 幻灯片
          • 添加评论
          • 删除评论
          • 结束评论
          • 对于评论的回复评论
        • 应用表格
          • 添加评论
          • 对于评论的回复评论
          • 删除评论
      • 讨论(Discussion)
        • 轻文档
          • 发送讨论消息
      • 提及(MentionAt @ 人)
        • 轻文档
          • 在评论中 at
          • 在讨论中 at
          • 在正文中 at
        • 表格
          • 在评论中 at
          • 在正文中 at
        • 传统文档
          • 在评论中 at
          • 在正文中 at
        • 应用表格
          • 在评论中 at
          • 在正文中 at
      • 日期提醒 (DateMention)
        • 轻文档
          • 创建
          • 修改
          • 删除
        • 表格
          • 创建
          • 修改
          • 删除
        • 传统文档
          • 创建
          • 修改
          • 删除
      • 文件内容更新 (FileContent)
        • 文件内容更新
      • 文档协作者协同状态变化 (Collaborator)
        • 文档协作者协同状态变化
      • 文件版本 (Revision)
        • 版本
      • 系统事件 (System)
        • 系统事件
      • 回调请求错误(实验性)
        • 回调请求错误
  • 09. 核心模型
    • 你的应用如何设计应用(app)模型?
    • 你的应用如何设计文件数据模型?
    • 你的应用如何设计通讯录模型?
    • 你的应用系统如何设计文件权限模型?
  • 10. 典型场景方案
    • 云盘场景
    • IM 场景
    • 示例代码仓库
  • 11. 常见问题
    • 访问接口提示 Signature
    • 文件预览或导入报错
    • 首次接入 SDK 报错
    • 文档预览如何做防盗链
    • 复制粘贴、全屏操作不正常
    • 如何实现文档模板功能
    • 文档内容何时保存
    • 移动端不支持 blob 协议导致预览失败
    • 如何实现文件重命名
    • 如何通过接口修改文档内容
    • @人员时如何直接跳转至对应锚点
  1. 文件-表格文件(Excel) API

表格接口参数说明

概述#

本文档详细说明表格操作接口中的关键参数格式和使用方法,帮助开发者正确构造请求参数。

参数详解#

📍 range 参数 - 指定操作范围#

作用:指定要操作的工作表和单元格范围
格式:{工作表名称}!{单元格范围}

基本格式说明#

组成部分说明示例
工作表名称要操作的工作表名称工作表1
!分隔符(必需)-
单元格范围具体的单元格位置A1 或 A1:C10

单元格范围格式#

单个单元格:A1, B5, Z100
范围选择:A1:C10, B2:F8
⚠️ 重要限制:单元格位置不能超过表格的最大行列数

工作表名称特殊字符处理#

当工作表名称包含以下特殊字符时,必须用单引号包裹:
! (感叹号)
: (冒号)
' (单引号)

完整示例#


📊 resource 参数 - 表格数据内容#

作用:定义要追加或更新的表格数据
格式:固定的对象结构,包含 values 字段

数据结构#

数据类型说明#

数据类型表示方法示例
文本字符串"hello", "产品名称"
数字数值123, 3.14, -50
空单元格空字符串""
日期OADate 数值44769 (表示 2022/7/27)

实际应用示例#

示例 1:添加单行数据
{
  "resource": {
    "values": [[1, "苹果", "水果"]]
  }
}
效果:
ABC
1苹果水果
示例 2:添加多行数据
{
  "resource": {
    "values": [
      [1, "苹果", "水果"],
      [2, "胡萝卜", "蔬菜"],
      [3, "", "空白分类"]
    ]
  }
}
效果:
ABC
1苹果水果
2胡萝卜蔬菜
3(空)空白分类
示例 3:包含空单元格
{
  "resource": {
    "values": [
      ["产品", "", "价格"],
      ["", "苹果", 5.5],
      ["编号", "001", ""]
    ]
  }
}

📅 日期处理 - OADate 转换#

问题:表格中的日期以 OADate 数值格式返回,需要转换为可读的日期格式
示例:日期 2022/7/27 在接口中返回为 44769

快速转换工具#

完整转换函数(生产环境推荐)#

常见问题与解决方案#

❓ 常见错误#

1.
工作表名称错误
2.
单元格范围超限
3.
数据类型混淆

💡 最佳实践#

1.
参数验证:发送请求前验证 range 格式
2.
错误处理:处理超出范围的单元格引用
3.
数据清洗:确保 values 数组结构正确
4.
日期处理:统一使用转换函数处理日期数据

参数组合示例#

完整的请求参数示例#

这样的文档结构让开发者能够:
快速理解每个参数的作用和格式要求
通过示例学习正确的使用方法
避免常见的参数错误
正确处理日期等特殊数据类型
修改于 2026-06-22 02:43:30
上一页
文件-表格文件(Excel) API
下一页
获取表格内容
Built with