配置 飞书多维表格 数据源
AE 数据开发平台支持将 飞书多维表格 当做数据源,将表格中的数据写入预置仓进行数据同步操作。
本文将为您介绍 飞书多维表格LarkSheet 数据源的配置能力。
支持的版本
- 任意 Saas 版本或私有化部署的飞书多维表格。
使用限制
- 飞书多维表格数据源仅支持离线读取(作为数据来源),不支持作为数据去向写入。
- 读取多维表格数据时,仅支持读取 String/ Datetime/ Date 类型的字段,暂不支持读取为其他数据类型。
- 飞书电子表格没有表头的概念,但为了飞书电子表格导入任务具有更好的规范性,我们约定:
表格中的第一行会作为表头 。表头需要是:从 A1 单元格开始的,连续的,非空的,不能重名的一系列单元格。 表头只用于做字段映射,不会参与数据传输。
例如表头行数据如下:- 非法表头(D列为空)
| A | B | C | D | E |
|---|---|---|---|---|
| 姓名 | 年龄 | 爱好 | 学校 |
使用前提
1. 准备飞书自建应用并配置权限
Refer: https://open.feishu.cn/document/best-practices/intro-to-custom-app-review
调用飞书 API 需要表格 owner 授权“飞书云文档应用(又称飞书企业自建应用)”来进行数据抓取
企业内部的应用程序,因此需要先准备好一个权限完善的应用。
提前在飞书开放平台创建“企业自建应用”,并授予企业自建应用关于电子表格的读取和编辑权限。
具体授予权限如下:
-
查看、编辑和管理知识库:wiki:wiki
-
查看、评论、编辑和管理文档:docs:doc
-
查看、评论、编辑和管理多维表格:bitable:app
-
查看、评论、编辑和管理电子表格:sheets:spreadsheet
-
查看、评论、编辑和管理云空间中所有文件:drive:drive
-
判断当前用户是否有云文档权限:docs:permission.member:auth
详见企业自建应用的开发流程。
2. 获取 App ID 和 App Secret
需要通过飞书开发者后台获取 应用凭证,并填入 AE 数开平台的连接器,测试连接通过。
将获取的 App id 和 Secret 填入集成方案数据源配置中
3. 找到需要接入的多维表格
为需要接入的多维表格分配权限,至少需分配 组织内获得链接的人可阅读 这项权限。
- 若选择了组织内获得链接的人 可阅读/可编辑,则在数开中获取链接的飞书表格中数据时,会进行组织权限校验;
- 若选择了互联网上获得链接的人 可阅读/可编辑,则该链接对应的飞书表格数据可以直接获取。
请关注企业数据安全性,分配合适的权限,保管好链接信息
在飞书多维表格中,添加文档应用,添加已创建的“企业自建应用”,并授予相应阅读或编辑权限。
4. 获取多维表格链接
获取需要对接的 多维表格的链接。
5. 支持的多维表格获取方式
| 多维表格存储位置 | 说明 | 是否支持 |
|---|---|---|
| Wiki 知识库中的多维表格 | 知识库中的资源是指挂载在知识库(wiki)中的资源。
| 支持 |
| 个人 Base 下的多维表格 | 个人飞书云盘下的多维表格资源。
| 支持 |
| 飞书云文档Doc 中的多维表格 | 内嵌在飞书云文档中的多维表格 | 暂不支持 |
创建飞书多维表格数据源
在 数据开发平台 - 集成 模块,您可以选择 新增 飞书多维表格 数据源
数据源配置参数信息
填写数据源所需的配置信息并完成连通性测试后,即可成功创建 飞书多维表格数据源。
| 字段名称 | 说明 |
|---|---|
| 基本信息 | |
| *数据源名称 | 数开平台空间内唯一,必须以字母、数字、下划线组合,且不能以数字和下划线开头 |
| 备注 | 选填 |
| 数据源配置 | |
| APP ID | 应用凭证账号 |
| APP Secret | 应用凭证密码 |
| Base URL | 域名,默认为 https://open.feishu.cn 企业私有化部署的飞书,请注意填写私有化域名 |
其中参数名称前带 * 的为必填参数,名称前未带 * 的为可选填参数。
创建离线同步任务
根据上述步骤成功 创建飞书多维表格数据源 并测试连通性成功后,您可根据实际场景,配置 飞书多维表格离线读取 的任务。
飞书多维表格 作为数据来源
数据来源选择 飞书多维表格,并完成以下相关参数配置:
| 字段名称 | 说明 |
|---|---|
| *源类型 | 数据来源目标类型选择 飞书多维表格 |
| *数据源名称 | 已在数据源管理界面注册的 飞书数据源,下拉可选。 若还未建立相应数据源,可单击 数据源管理 按钮,前往创建 飞书多维表格 数据源。 |
| *多维表格URL | 请复制想要同步的飞书多维表格 url ,粘贴入文本框,并点击「检验URL」 |
| *来源数据表 | 读取的飞书多维表格下的数据表名称,用户可下拉进行选择
|
| *来源视图 | 读取的数据表下的视图名称,用户可下拉进行选择
|
若数据获取不成功,则可能存在的异常提示及处理方案:
- 请检查飞书集成连通性:集成未启用、配置信息不全或 token 失效;
- 没有权限获取表格信息,请开通对应 API 的接口权限:飞书应用的 API 权限没开;
- 请提供有效的飞书多维表格链接:检查提供的链接是否有误;
- 请求飞书接口失败:数据太大,服务器计算超时 或 上次提交的修改还没有处理完可以适当进行重试;
- 请检查表格链接的权限配置:电子表格、多维表格的链接分享范围需要调整;
- 飞书 api 接口请求失败:可以从飞书官方报错文档里找到对应报错原因;
支持的字段类型
因飞书电子表格无强制的 Schema 约束,除了 Date, Datetime 字段类型会识别并特殊处理,数据开发平台会将表格中的每个单元格统一当做 string 来处理,目标 Writer 数据源中对应的字段最好也是 string 类型,否则会可能会出现数据格式转化出错导致的作业失败。
- 默认读取至表格最后的有数据列或根据自定义列数读取,中间空列以 null 填充
- 空行会被飞书电子表格计入到sheet的行数里,可能会出现空数据。
- 列名不可重复
- 不支持公式的处理
字段映射说明
完成数据来源和目标端配置后,需建立字段映射关系,系统将按照映射关系将源端字段中的数据自动同步至目标字段中。字段映射关系有三种配置方式:
- 方式一:自定义选择,选中源表字段,并选择目标表中目标字段
- 方式二:同名映射,系统会自动为源表和目标表中的同名字段建立映射关系
- 方式三:同行映射,系统会自动为同行字段建立映射关系
需要注意一个目标字段只能对应一个来源字段
基本信息设置
最后,您需要设置集成方案的基本信息,包括方案的名称、负责人、集成的同步速率以及备注等。
完成配置后,可以点击 「保存」 按钮完成集成方案的创建。
注:方案名称保存后不允许修改
详情页展示:
离线同步方案挂流
挂载任务流
1.进入挂载流程
- 在集成方案详情页,点击右上角「挂载到任务流」按钮
2.选择任务流
-
从下拉菜单中选择目标任务流
-
若需新建任务流:
- 点击下拉菜单下方的「新建任务流」快捷按钮
- 或前往「开发」模块创建
-
提示:如未显示目标任务流,可点击右侧↻刷新按钮
3.创建同步节点
- 在任务流中新建「离线同步方案」类型节点
- 该节点将关联当前集成方案,节点执行时即触发对应集成方案的运行
4.完成挂载
- 点击「创建节点并挂载」完成配置
- 挂载成功后,可点击「前往任务流」立即查看挂载结果
注:挂载任务流所创建的任务节点处于 尚未发布状态,建议您前往查看任务流,并将该节点发布上线。
解除任务流挂载
如果您希望解除离线同步方案的任务流挂载,
- 若该任务流还未发布上线,您可前往该方案挂载的任务流,在 开发模式 删除该「离线同步方案」任务节点即可。
- 若该任务流已经发布上线,在 开发模式 删除该「离线同步方案」任务节点后,您需要重新发布该任务流,即同步解除了该节点在 生产环境 上的挂载。

