To download the app, visit: [connectors](https://tulip.co/library/<span translate=)/microsoft-excel-connector/">Library
Microsoft Excel 连接器
与 Microsoft O365 Worksheet V1.0 API 的集成
简介
Microsoft Excel 工作表 API 允许用户在为其 Office 365 帐户设置适当访问权限后,创建、读取和编辑 Microsoft Excel 工作表。 此连接器的目标是通过 HTTP 连接器,利用 Microsoft Graph API(v1.0)将 Tulip 与 Microsoft 集成,并为客户提供可直接导入其实例的开箱即用型连接器。
目的
本文将重点介绍通过向 Microsoft Graph API(v1.0)发起 HTTP 调用来构建的各种连接器功能,这些功能可与 M365 Excel 工作表进行交互,并演示可在工作表上执行的各种读写操作,这些操作可应用于多种使用场景。
API 文档
先决条件
- 在 Microsoft O365 上创建一个账户,并在 Microsoft Entra ID 中配置 OAuth 2.0 凭据。
- 在 Microsoft 门户中注册 API 并指定所需的权限范围。Azure - Entra ID
连接器设置视频:
Tulip 连接详细信息
需要在 Tulip 的
连接器上配置以下信息。
- 运行环境:云连接器主机
- 主机:graph.microsoft.com
- 端口:443
- TLS:是
OAuth 2:用于获取访问令牌,以便与 Microsoft Graph API 进行通信
连接器功能
1) 获取一个驱动器的详细信息
用途
此连接器将从一个驱动器中获取所有项目。
端点
向端点https://graph.micrsoft.com:443/v1.0/me/drive/root/children发起 HTTP GET 请求
必需输入
无需输入
必需的输出提取器
- 工作表ID:工作簿的唯一标识符,将用于执行其他任务。
- CreatedAt:工作簿的创建日期和时间。
- LastModified:工作簿的最后修改日期和时间。
- SheetName:工作簿名称。
- 电子表格URL:工作簿的URL。
2) 获取工作簿中的所有工作表
用途
该连接器将通过传入工作簿 ID 来获取工作簿中的所有工作表。
端点
向端点https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets发送 HTTP GET 请求
必需输入
以下是需要传递的 URL 参数
- 工作簿 ID
必需输出提取器
- sheetId:电子表格的唯一标识符,将用于执行其他任务。
- sheetName:工作表的显示名称。
- sheetPosition:工作表在工作簿中的位置(从 0 开始计数)。
- sheetVisibility:工作表的可见性。可能的值包括 Visible、Hidden 和 VeryHidden。
3) 获取工作表元数据
用途
该连接器将根据工作簿 ID 和工作表名称获取数据。
端点
向端点https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/发起 HTTP GET 请求
必需输入
以下是需要传递的 URL 参数
- 工作簿 ID
- 工作表名称
必需的输出提取器
- sheetId:电子表格的唯一标识符,将用于执行其他任务。
- sheetName:工作表的显示名称。
- sheetPosition:工作表在工作簿中的位置(从零开始计数)。
- sheetVisibility:工作表的可见性。可能的值包括:Visible、Hidden、VeryHidden。
4) 创建新工作表
用途
- 用户可将工作簿 ID 和工作表名称作为输入参数传递,Tulip 将根据提供的名称创建一个新工作表。API 的响应将包含该工作表的元数据及各项属性。这些信息可进一步用于从工作表中获取和更新数据。
- 信息从 Microsoft Graph V1.0 API 获取,随后可在 Tulip 应用、Tulip 表格或 Tulip 变量中使用,并可通过管道传输至其他连接器函数。
端点
向端点https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/add发送 HTTP POST 请求
必填输入
以下参数将作为请求正文发送
- 工作簿 ID - 工作簿 ID
- 工作表名称 - 工作表标题
必需的输出提取器
- WorksheetId:电子表格的唯一标识符,将用于执行其他任务。
- spreadsheetURL:新创建的电子表格的 URL。
- 响应中返回的其他参数可作为输出参数的一部分包含在内。
5) 更新工作表属性
目的
用户可将工作簿 ID、旧工作表名称、工作表位置和新工作表名称作为输入参数传递,Tulip 将根据提供的名称更新该工作表。API 的响应将包含工作表的元数据及其各项属性。这些信息可进一步用于从电子表格中获取和更新数据。
端点
向端点https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}发起 HTTP PATCH 请求
必填输入
以下参数将作为请求正文发送
- 工作簿 ID - 工作簿 ID
- 工作表名称 - 工作表标题
- 工作表位置 - 该工作表在工作簿中的位置(从零开始计数)
- 新工作表名称 - 新工作表的标题
必需的输出提取器
- sheetID:工作簿的唯一标识符,将用于执行其他任务
- sheetName:工作表的显示名称。
- sheetPosition:工作表在工作簿中的基于零的索引位置。
6) 获取特定单元格的数据
用途
该连接器将根据提供的“工作簿ID”、“工作表名称”、“行索引”和“列索引”作为输入,从工作簿的工作表中获取数据。API的响应将返回指定单元格的数值。
端点
向端点https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/cell(row={行索引},column={列索引})发起 HTTP GET 请求
必填输入
以下是需要传递的 URL 参数
- 工作簿 ID - 工作簿 ID
- 工作表名称 - 工作表标题
- 行索引 - 待检索单元格的行号
- 列索引——要检索的单元格的列号
必需的输出提取器
此连接器将返回指定行和列索引对应的单元格值。
7) 获取工作表区域数据
用途
该连接器将根据提供的“工作簿 ID”、“工作表名称”、“起始范围”和“结束范围”作为输入,从工作簿的工作表中获取数据。API 的响应将是所提供范围内的数据。
端点
向以下端点发送 HTTP GET 请求:https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/range(address=’{start range}:{end range}’)
必填输入
以下是需要传递的 URL 参数
- 工作簿 ID——工作簿 ID
- 工作表名称 - 工作表标题
- 起始范围 - 起始范围
- 结束范围 - 结束范围
必需的输出提取器
此连接器将返回指定范围内的所有单元格值。
8) 按范围更新值
用途
用户可将工作簿 ID、工作表名称、起始范围、结束范围以及待更新的值作为输入参数传递,Tulip 将根据提供的范围更新该范围内的值。API 的响应将包含更新后的范围值。
端点
向以下端点发起 HTTP PATCH 请求:https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/range(address=’{start range}:{end range}’)
必填输入
以下是需要传递的 URL 参数
- 工作簿 ID——工作簿 ID
- 工作表名称 - 工作表标题
- 起始范围 - 起始范围
- 结束范围 - 结束范围
- 所提供范围内的每个单元格的值
所需的输出提取器
我们不需要任何输出提取器。
9) 在工作表中创建一个表格
目的
- 用户可将工作簿 ID、工作表名称、工作表地址以及“是否包含表头”作为输入参数传递,Tulip 将据此创建一个新表格并指定其名称。API 的响应将包含该表格的元数据及各项属性。
- 该表可进一步用于从电子表格中获取和更新数据。
- 从 Microsoft Graph V1.0 API 获取的信息随后可在 Tulip 应用、Tulip 表格或 Tulip 变量中使用,并可通过管道传输至其他连接器函数。
端点
向端点https://graph.microsoft.com:443/v1.0/me/drive/items/{itemID}/workbook/worksheets/add发送 HTTP POST 请求
必需输入
以下是作为请求正文发送的参数
- 工作簿 ID - 工作簿 ID
- 工作表名称 - 工作表标题
- 地址 - 代表数据源的区域对象的地址或名称。如果地址中不包含工作表名称,则使用当前活动工作表。
- hasHeaders - 布尔值,用于指示要导入的数据是否包含列标签。如果数据源不包含标题行(即当此属性设置为 false 时),Excel 将自动生成标题行,并将数据向下移动一行
必需的输出提取器
此方法返回新创建表格的元数据值。
10) 在表格中添加新行
用途
用户可将工作簿 ID、表格名称和行值作为输入参数传递,Tulip 将根据提供的行值创建新行。API 的响应将包含该表格中已创建的行值。
端点
向端点https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/tables/{tablename}/rows/add发起 HTTP POST 请求
必填输入
以下参数将作为请求正文发送
- 工作簿 ID - 工作簿 ID
- 工作表名称 - 工作表标题
- 行值
必需的输出提取器
这将返回新创建行的行值。
11) 清除工作表数据
目的
用户可以传入工作簿 ID、工作表名称、起始范围和结束范围作为输入,Tulip 将根据给定的范围清除单元格值。
端点
向端点https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheet/{worksheetName}/range(address=’{start range}:{end range}’)/clear发送 HTTP POST 请求
必填输入
以下是作为请求正文发送的参数
- 工作簿 ID - 工作簿 ID
- 工作表名称 - 工作表标题
- 起始范围
- 结束范围
进一步阅读
查看有关 Microsoft 连接器的更多信息
