集成钉钉表格

魔笔平台提供了强大的钉钉表格集成功能,允许用户通过简单的配置,实现对钉钉表格服务的无缝连接和数据交互。本文档将指导您如何创建和使用钉钉表格集成。

功能介绍

魔笔平台的钉钉表格集成功能支持以下特点:

  • 自定义触发方式:集成操作可以设置为手动触发或自动运行,满足不同的业务场景需求。

  • 回调和数据转换:支持在查询成功或失败时执行特定的集成操作事件,以及对返回的数据进行自定义处理。

  • 高级设置:提供防抖和禁止执行条件的高级配置,以优化集成操作的执行。

事件相关内容可参考:集成操作事件

使用钉钉表格集成

步骤 1:创建钉钉表格集成

  1. 登录魔笔平台,进入管控台。

  2. 导航至“资源”->“集成”,点击“创建集成”。

  3. 选择“钉钉表格配置”,并填写集成名称及描述。

  4. 配置不同环境的钉钉表格集成信息,包括appKeyappSecret等。

  5. 点击“确定”以创建钉钉表格集成。

步骤 2:在应用内部创建集成操作

  1. 打开“代码”面板,点击对应作用域的“+”后选中“集成操作”。

    image

  2. 选择之前创建的钉钉表格集成作为资源,选择操作类型,根据需求填写参数,最后选择集成操作的触发方式,增加更多细节配置。image

  3. 点击“运行”预览查询效果。

配置面板详解

集成配置

  • appKey 与 appSecret:钉钉应用开发平台的访问凭证,需要在开发者后台查看应用的 Cilent ID(原企业内部应用AppKey)和 Cilent Secret(原企业内部应用AppSecret)。详情请参考获取企业内部应用 accessToken

image

重要

请确保您的应用拥有知识库读写权限、知识库节点读写权限和钉钉表格读写权限。关于如何给应用添加权限,请参考添加接口调用权限

通用配置

  • 获取我的文档知识库信息:

    • 操作人:操作人的 unionId,unionId是应用内用户的唯一标识符,可以通过集成钉钉用户中通过查询用户详情操作,使用用户 ID 查询该用户的 unionId。关于使用钉钉用户集成,请参考集成钉钉用户

  • 创建知识库文档:

    • 知识库 Id:通过获取我的文档知识库信息的返回值中的 workspaceId(知识库 Id)获取。

    • 文档名称:文档的名称。

    • 文档类型:文档类型,包括文字、表格、脑图和文件夹。

    • 操作人:操作人的 unionId,unionId是应用内用户的唯一标识符,可以通过集成钉钉用户中通过查询用户详情操作,使用用户 ID 查询该用户的 unionId。关于使用钉钉用户集成,请参考集成钉钉用户

    • 父节点 Id:父节点Id,如果不传,默认在根目录创建。父节点可以是文件夹,也可以是普通的文档。

  • 获取节点列表:

    • 操作人:操作人的 unionId,unionId是应用内用户的唯一标识符,可以通过集成钉钉用户中通过查询用户详情操作,使用用户 ID 查询该用户的 unionId。关于使用钉钉用户集成,请参考集成钉钉用户

    • 父节点 Id:通过获取我的文档知识库信息的返回值 rootNodeId 获取。

    • 分页游标:下一页的token,用于分页,如果一个查询条件一次无法全部返回结果,会返回分页token,下次查询带上该token后会返回后续数据,直到分页tokennull表示数据已经全部查询完毕。

    • 分页大小:分页大小,默认值50,最大值50。

  • 获取所有工作表:

    • 表格 Id:获取节点列表中返回的 nodeId 即为表格Id。

    • 操作人:操作人的 unionId,unionId是应用内用户的唯一标识符,可以通过集成钉钉用户中通过查询用户详情操作,使用用户 ID 查询该用户的 unionId。关于使用钉钉用户集成,请参考集成钉钉用户

  • 更新表格单元格区域:

    • 表格 Id:获取节点列表中返回的 nodeId 即为表格Id。

    • 工作表 Id: 通过获取所有工作表的返回值 id 获取。

    • Range 地址:更新的表格范围,例如 A1:C3。

    • 操作人:操作人的 unionId,unionId是应用内用户的唯一标识符,可以通过集成钉钉用户中通过查询用户详情操作,使用用户 ID 查询该用户的 unionId。关于使用钉钉用户集成,请参考集成钉钉用户

    • 单元格的值:单元格的值,根据Range地址范围传参,格式为二维数组。

    • 背景色:背景色,颜色的16进制值,根据Range地址范围传参,格式为二维数组。

    • 超链接:超链接,根据Range地址范围传参,格式为二维数组。

    • 数字格式:数字格式,详见更新单元格区域

      重要

      对于单元格的值背景色超链接数字格式。Range地址范围有几行,该参数二维数组内就有几个元素;Range地址范围内有几列,该参数二维数组每个元素内就有几个值。详情请参考更新单元格区域

  • 获取表格单元格区域

    • 表格 Id:获取节点列表中返回的 nodeId 即为表格Id。

    • 工作表 Id: 通过获取所有工作表的返回值 id 获取。

    • Range 地址:更新的表格范围,例如 A1:C3。

    • 操作人:操作人的 unionId,unionId是应用内用户的唯一标识符,可以通过集成钉钉用户中通过查询用户详情操作,使用用户 ID 查询该用户的 unionId。关于使用钉钉用户集成,请参考集成钉钉用户

回调配置

  • 数据转化:对接口返回的数据进行处理,默认为return data,即不进行处理。

  • 流式接收回调:配置流式调用接口 chunk 数据获取时触发的事件。

  • 成功回调:配置接口调用成功时触发的事件。

  • 失败回调:配置接口调用失败时触发的事件。

高级配置

  • 防抖:设置防抖表达式,避免接口的频繁调用。

  • 禁止执行条件:根据条件表达式确定是否执行此集成操作。

手动触发集成

事件触发

  1. 在需要触发集成操作的组件中,配置事件处理器。

  2. 将动作类型设置为集成操作,并选择相应的集成。

  3. 以对象形式填写已配置的参数。

API 触发

若此集成操作的名称为action1,则在任何可以执行脚本的地方,可以使用action1.trigger()方法触发集成操作,若集成操作配置了参数,则需要以对象形式填写已配置的参数。