Excel Online

使用 Excel Online 连接器对 Excel Online 执行操作。

准备工作

配置您的 Google Cloud 项目、创建 OAuth 应用并授予所需权限。

配置 Google Cloud 项目

在使用 Excel Online 连接器之前，请在 Google Cloud 项目中执行以下任务：

• 确保已设置网络连接。如需了解网络模式，请参阅网络连接。
• 启用以下服务：
  • secretmanager.googleapis.com (Secret Manager API)
  • connectors.googleapis.com (Connectors API)

  如需了解如何启用服务，请参阅启用服务。

如果之前没有为您的项目启用这些服务或权限，则在您配置连接器时，系统会提示您启用。

创建自定义 OAuth 应用 - Azure AD

1. 登录 Azure 门户。
2. 在左侧导航窗格中，依次选择“Azure Active Directory”和“applicationRegistrations”。
3. 点击“新注册”。
4. 输入应用的名称。
5. 选择所需的租户设置：单租户或多租户，以及公开或私享使用。
• 如果您选择默认选项“仅此组织目录中的账号”，则在使用适用于 Microsoft Excel Online 的 CData JDBC 驱动程序建立连接时，必须将 AzureTenant 连接属性设置为 Azure AD 租户的 ID。否则，身份验证尝试将失败并显示错误。
• 如果您的应用仅供内部使用，请指定“仅此组织目录中的账号”。
• 如果您想分发应用，请选择多租户选项之一。
6. 将重定向网址设置为 http://localhost:33333（驱动程序的默认值），或指定其他端口并将 Callback网址 设置为您定义的确切回复网址。
7. 点击“注册”以注册新应用。系统随即会显示应用管理界面。记下“应用（客户端）ID”中的值作为 OAuthClientId，并将“目录（租户）ID”作为 AzureTenant。
8. 前往“证书和密钥”，然后定义应用身份验证类型。可用的身份验证类型有两种：证书（推荐）或客户端密钥。
• 对于证书身份验证：在“证书和密钥”中，选择“上传证书”，然后从本地机器上传证书。
• 如需创建新的客户端密钥，请在“证书和密钥”中为应用选择“新建客户端密钥”，然后指定其有效期。保存客户端密钥后，Microsoft Excel Online 会显示密钥值。复制此值，因为该值仅显示一次。此值将成为 OAuthClientSecret。
9. 依次选择“API 权限”>“添加”>“委托的权限”。
10. 添加以下应用权限：Sites.Read.All、Files.Read、Files.Read.All、Files.Read.Selected、Files.ReadWrite、Files.ReadWrite.All、Files.ReadWrite.AppFolder、Files.ReadWrite.Selected 和 offline_access。
11. 保存更改。
12. 如果您指定了需要管理员同意才能使用的权限（例如应用权限），则可以在“API 权限”页面上从当前租户授予这些权限。

创建自定义 OAuth 应用 - Azure 服务主账号

1. 使用搜索栏搜索“订阅”服务。
2. 打开“订阅”页面。
3. 选择要向其分配应用的订阅。
4. 打开“访问控制 (IAM)”。
5. 依次选择“添加”>“添加角色分配”。Microsoft Excel Online 会打开“添加角色分配”页面。
6. 为您的自定义 Azure AD 应用分配“所有者”角色。

为应用分配角色

1. 如需访问订阅中的资源，您必须向应用分配角色。
2. 在搜索栏中搜索并选择“订阅”服务，打开“订阅”页面。
3. 选择要将应用分配到的订阅。
4. 打开“访问控制 (IAM)”，然后依次选择“添加”>“添加角色分配”，以打开“添加角色分配”页面。
5. 选择“Owner”（所有者）作为要分配给您创建的 Azure AD 应用的角色。

授予管理员同意

1. 登录 Azure 门户
2. 前往“应用注册”，然后找到您创建的自定义 OAuth 应用。
3. 在“API 权限”下，点击“授予同意”。

授予客户端凭据权限

1. 登录 Azure 门户
2. 前往“应用注册”。
3. 找到您刚刚创建的应用，然后打开“API 权限”。
4. 选择 Microsoft Graph 权限。有两组不同的权限：委托权限和应用权限。
5. 在“应用权限”下，选择您在集成时需要的权限。

配置连接器

配置连接器时，您需要创建与数据源（即后端系统）的连接。一个连接需专用于一个数据源。这意味着，如果您有许多数据源，则必须为每个数据源创建单独的连接。如需创建连接，请执行以下步骤：

1. 在 Cloud 控制台 中，进入 Integration Connectors > 连接页面，然后选择或创建一个 Google Cloud 项目。

   转到“连接”页面

2. 点击 + 新建以打开创建连接页面。
3. 在位置部分中，选择连接的位置。
   1. 区域：从下拉列表中选择一个位置。

      连接器支持的区域包括：

      如需查看所有受支持区域的列表，请参阅位置。

   2. 点击下一步。
4. 在连接详情部分中，完成以下操作：
   1. 连接器：从可用连接器的下拉列表中选择 Excel Online。
   2. 连接器版本：从可用版本的下拉列表中选择一个连接器版本。
   3. 在连接名称字段中，输入连接实例的名称。

      连接名称必须符合以下条件：

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头，以字母或数字结尾。
      • 连接名称不能超过 49 个字符。
   4. （可选）输入连接实例的说明。
   5. 您可以选择启用 Cloud Logging，然后选择日志级别。默认情况下，日志级别设置为 Error。
   6. 服务账号：选择具有所需角色的服务账号。
   7. （可选）配置连接节点设置：
      • 节点数下限：输入连接节点数下限。
      • 节点数上限：输入连接节点数上限。

      节点是处理事务的连接单元（或副本）。 连接处理越多事务就需要越多节点，相反，处理越少事务需要越少节点。 如需了解节点如何影响连接器价格，请参阅连接节点的价格。如果未输入任何值，则默认情况下，节点数下限设置为 2（以便提高可用性），节点数上限设置为 50。

   注意：仅当您是随用随付客户时，才能自定义连接节点值。
   8. Azure 租户：用于访问数据的 Microsoft 在线租户。如果未指定，则使用您的默认租户。
   9. 云端硬盘：云端硬盘的 ID。您可以使用“云端硬盘”和“SharePoint 网站”视图查看您有权访问的所有网站和云端硬盘。
   10. SharePoint 网址：SharePoint 服务器的基准网址。
   11. 显示共享文档：是否显示共享文档。
   12. 工作簿：工作簿的名称或 ID。
   13. 标题：指示是否应从第一行检测列名称。
   14. 表：将连接限制为包含工作表中单元格范围的表。格式：[{Workbook Name}_{Worksheet Name}!{Range}]
   15. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
   16. 点击下一步。
5. 1. 在身份验证部分中，输入身份验证详细信息。如需了解如何配置这些身份验证详细信息，请参阅配置身份验证。
   2. 点击下一步。
6. 查看：查看您的连接和身份验证详细信息。
7. 点击创建。

配置身份验证

根据您要使用的身份验证输入详细信息。

• 客户端 ID：请求访问令牌时所用的客户端 ID。
• 范围：所需范围的逗号分隔列表。
• 客户端密钥：请求访问令牌时所用的客户端密钥。
• 授权网址：创建客户端时生成的授权网址。

Excel Online - 网站连接类型

本部分列出了您在创建 Excel Online 连接时配置的各种字段的示例值。

字段名称	详细信息
位置	us-central1
连接器	Excelonline
连接器版本	1
连接名称	excelonline-gcp
服务账号	SERVICE_ACCOUNT_NAME@serviceaccount
Azure 租户	9b******-****-****-****-*********12
云端硬盘	b!p_648NCXwk6hJ1pfyn0SeFaithFnRM1JmYNur9asmHAs2k8qe5UsR5a1cX6luuD0
Sharepoint 网址	https://*****.sharepoint.com/
显示共享的文档	True
节点数下限	2
节点数上限	50
客户端 ID	e89*****-****-****-****-*********b6
范围	https://graph.microsoft.com/.default
客户端密钥	CLIENT_SECRET
Secret 版本	1
授权网址	https://login.microsoftonline.com/{Azure-Tenant}/oauth2/v2.0/authorize

创建连接后的其他步骤

如果您选择了 OAuth 2.0 - Authorization code 作为身份验证方式，则必须在创建连接后执行以下额外步骤：

1. 在“连接”页面中，找到新创建的连接。

   请注意，新连接器的状态将为需要授权。

2. 点击需要授权。

   系统随即会显示修改授权窗格。

3. 将重定向 URI 值复制到您的外部应用。
4. 验证授权详细信息。
5. 点击 Authorize（授权）。

   如果授权成功，“连接”页面中的连接状态将设为有效。

重新授权授权代码

如果您使用的是 Authorization code 身份验证类型，并且在 Azure Synapse 应用中进行了任何配置更改，则必须重新授权 Azure Synapse 连接。如需重新授权关联，请执行以下步骤：

1. 在“连接”页面中，点击所需的连接。

   系统随即会打开连接详情页面。

2. 点击修改以修改关联详情。
3. 在身份验证部分中，验证 OAuth 2.0 - 授权代码详细信息。

   根据需要进行必要的更改。

4. 点击保存。您随即会进入连接详情页面。
5. 点击身份验证部分中的修改授权。系统随即会显示 Authorize（授权）窗格。
6. 点击 Authorize（授权）。

   如果授权成功，“连接”页面中的连接状态将设为活跃。

系统限制

Excel Online 连接器可处理的 Excel 文件大小上限为 25 MB。

Excel Online 连接器每个节点每秒可处理 3 笔交易，并会对超出此限制的所有交易进行节流。默认情况下，Integration Connectors 会为连接分配 2 个节点（以提高可用性）。

如需了解适用于 Integration Connectors 的限制，请参阅限制。

注意：集成连接器节点的数量将根据您的使用情况动态扩缩。不过，如果您想为大量数据预留容量，而不必等待自动扩缩，则可以调整连接的最小节点值。连接处理越多事务就需要越多节点。相反，如果连接处理的事务较少，则需要的节点就越少。如需配置节点值，请执行以下操作：

• 如果您是随用随付客户，请在“修改关联”页面中配置节点的最小值和最大值。
• 如果您是订阅型客户，请与支持团队联系。

节点可处理的最大事务数取决于多种因素。因此，在调整最小节点数以提高吞吐量之前，建议您检查后端系统是否已以最佳方式设置，以处理所需的流量。

在集成中使用 Excel Online 连接

创建连接后，该连接将在 Apigee Integration 和 Application Integration 中可用。您可以通过连接器任务在集成中使用该连接。

• 如需了解如何在 Apigee Integration 中创建和使用连接器任务，请参阅连接器任务。
• 如需了解如何在 Application Integration 中创建和使用连接器任务，请参阅连接器任务。

实体、操作和动作

所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。

注意：您可以在连接器任务中查看连接器的实体、操作和动作。

• 实体：实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如，在数据库连接器中，表是实体；在文件服务器连接器中，文件夹是实体；在消息传递系统连接器中，队列是实体。

  但可能的情况是，连接器不支持或不具有任何实体，在这种情况下，Entities 列表将为空。

• 操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：
  • 列表
  • 获取
  • 创建
  • 更新
  • 删除

  从可用列表中选择一个实体，系统会生成该实体可用的操作列表。如需了解操作的详细说明，请参阅连接器任务的实体操作。不过，如果连接器不支持任何实体操作，则 Operations 列表中不会列出此类不受支持的操作。

• 动作：动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改，并且动作因连接器而异。通常，操作会有一些输入参数和一个输出参数。但可能的情况是，连接器不支持任何动作，在这种情况下，Actions 列表将为空。

注意： 所有实体和操作都具有与之关联的架构。例如，动作架构将包含参数详细信息，例如：参数名称及其相应的数据类型。实体和操作的架构（元数据）由连接在运行时从后端提取。如果架构有任何更新，此类更新不会自动反映在现有连接中；您必须手动刷新架构。如需刷新连接的架构，请打开连接的连接详情页面，然后点击刷新连接架构。

操作

本部分列出了该连接器支持的操作。如需了解如何配置操作，请参阅操作示例。

注意：在您运行集成后，所有操作的结果将以 JSON 响应的形式在 Connectors 任务的 connectorOutputPayload 响应参数中提供。

添加工作表操作

向现有 Excel Online 工作簿添加工作表。

AddWorksheet 操作的输入参数

参数名称	数据类型	必填	说明
标题	字符串	True	工作表的名称。
WorkbookId	字符串	True	工作簿的 ID。此 ID 必须属于可通过当前连接属性访问的云端硬盘。

AddWorksheet 操作的输出参数

如需了解如何配置 AddWorksheet 操作，请参阅示例。

示例

本部分介绍如何在此连接器中执行一些操作。

操作示例

本部分介绍如何在此连接器中执行一些操作。

示例 - 执行 AddWorksheet 操作

此示例将工作表添加到现有的 Excel Online 工作簿。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 AddWorksheet 操作，然后点击完成。
3. 在数据映射部分中，Open Data Mapping Editor，然后在 Input 字段中输入类似于以下内容的值：

   {   
   "WorkbookId": "01M7ENMYA2QJVY77NPOFD3WQIJ6PNNX5VL",
   "Title": "Worksheet_SP1"
   }

如果操作成功，AddWorksheet 任务的 connectorOutputPayload 响应参数的值将类似于以下内容：

[{
  "Success": "true",
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#workbookWorksheet",
  "@odata.type": "#microsoft.graph.workbookWorksheet",
  "@odata.id": "/drives('b%21p_648NCXwk6hJ1pfyn0SeFaithFnRM1JmYNur9asmHAs2k8qe5UsR5a1cX6luuD0')/items('01M7ENMYA2QJVY77NPOFD3WQIJ6PNNX5VL')/workbook/worksheets(%27%7BD9372F53-CB1B-4082-9E13-02E65C2FC233%7D%27)",
  "id": "{D9372F53-CB1B-4082-9E13-02E65C2FC233}",
  "name": "Worksheet_SP1",
  "position": "1",
  "visibility": "Visible"
}]

实体操作示例

本部分介绍如何在此连接器中执行一些实体操作。

示例 - 列出所有云端硬盘

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择“云端硬盘”。
3. 选择 List 操作，然后点击完成。

示例 - 列出所有 SharedDocument

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择“SharedDocuments”。
3. 选择 List 操作，然后点击完成。

示例 - 列出所有工作簿

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择“工作簿”。
3. 选择 List 操作，然后点击完成。

示例 - 获取云端硬盘

1. 在 Configure connector task 对话框中，点击 Entities。
Entity 列表中的云端硬盘。
2. 选择 Get 操作，然后点击完成。
3. 将实体 ID 设置为“获取单个云端硬盘”。如需设置实体 ID，请在数据映射的数据映射器部分，点击打开数据映射编辑器，然后在输入值字段中输入 b!ZETdEU1T_UOBEzbgDmsvcubxvUaXbcJNrrNPM4LqokkwLC3zCRPiQLi2PBfCs9-v ，并选择 EntityId 作为本地变量。

示例 - 获取 SharedDocument

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择“SharedDocuments”。
3. 选择 Get 操作，然后点击完成。
4. 将实体 ID 设置为“Get single SharedDocument”。如需设置实体 ID，请在数据映射的数据映射器部分，点击打开数据映射编辑器，然后在输入值字段中输入 01BDTL6TS3OQ3HDXCKGREILDYKY47S7LEI，并选择 EntityId 作为本地变量。

示例 - 获取工作簿

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择“工作簿”。
3. 选择 Get 操作，然后点击完成。
4. 将实体 ID 设置为“Get single Workbooks”。如需设置实体 ID，请在数据映射的数据映射器部分，点击打开数据映射编辑器，然后在输入值字段中输入 01M7ENMYA2QJVY77NPOFD3WQIJ6PNNX5VL，并选择 EntityId 作为本地变量。

示例 - 从图书中删除数据

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择“Book 4567_Sheet1”。
3. 选择 Delete 操作，然后点击完成。
4. 将实体 ID 设置为“Delete Book 4567_Sheet1”。如需设置实体 ID，请在数据映射的数据映射器部分，点击打开数据映射编辑器，然后在输入值字段中输入 5.0，并选择 EntityId 作为本地变量。

示例 - 为 Formulae_Sheet_List 创建公式

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Formulae_Sheet_List。
3. 选择 Create 操作，然后点击完成。
4. 在任务的数据映射器部分中，点击 OpenDataMapping 编辑器，然后在 field: 中输入类似于以下内容的值

    {
     "Excel_Sheet": "Old_Excel",
     "B": "=SUM(C8:D8)",
     "C": "6",
     "D": "6"
     }
     
   Running this example, returns a response similar to the following in the Connector
     task's connectorOutputPayload output variable:
     
   {
     "Id": 8.0
     } 
     

Example - Create With_Headers

1. In the Configure connector task dialog, click Entities.
2. Select Book 4567_Book4567_Sheet1 from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data mapper section of the Task click OpenDataMapping editor and then enter a value similar to the following in the field:

    {
       "Name": "workbooknew",
       "Type": "newly created",
       "Sl no": 5.0
     }
     
   Running this example, returns a response similar to the following in the Connector
     task's connectorOutputPayload output variable:
     
   {
     "Id": 6.0
     }
     

Example - Create Without_Headers

1. In the Configure connector task dialog, click Entities.
2. Select Book 4567_Book4567_Sheet1 from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data mapper section of the Task click OpenDataMapping editor and then enter a value similar to the following in the field:

     {
       "A": "6",
       "B": "Halo",
       "C": "Stardust"
     } 
     
   Running this example, returns a response similar to the following in the Connector
     task's connectorOutputPayload output variable:
     
   {
     "Id": 7.0
     } 
     

Example - Update an Formula for Formulae_Sheet_List

1. In the Configure connector task dialog, click Entities.
2. Select Formulae_Sheet_List from the Entity list.
3. Select the Update operation, and then click Done.
4. Set the entity ID to Update a Formulae_Sheet_List. To set the entity ID, in the Data mapper section of the Tasks, click entityId and then enter 8.0 in the given field.
5. In the Data mapper section of the Task click OpenDataMapping editor and then enter a value similar to the following in the field:

    
     {
     "B": "=MAX(C8:D8)",
     "C": "7",
     "D": "10"
     } 
     

运行此示例会在连接器任务的 connectorOutputPayload 输出变量中返回类似于以下内容的响应：

 
  {   
  "Id": 8.0
  }
  

示例 - 更新 Without_Header

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择“Book 4567_Book4567_Sheet1”。
3. 选择 Update 操作，然后点击完成。
4. 将实体 ID 设置为更新图书 4567_Book4567_Sheet1。如需设置实体 ID，请在任务的数据映射器部分，点击 entityId，然后在给定字段中输入 7.0。
5. 在任务的数据映射器部分中，点击 OpenDataMapping 编辑器，然后在 field: 中输入类似于以下内容的值

    
      {
       "B": "cosmically",
       "C": "interlinked"
     }  
     

运行此示例会在连接器任务的 connectorOutputPayload 输出变量中返回类似于以下内容的响应：

 
  {   
  "Id": 7.0
  }
  

示例 - Update_With_Header

1. 在 Configure connector task 对话框中，点击 Entities。
li> 从 Entity 列表中选择工作簿 4567_Book4567_Sheet1。
2. 选择 Update 操作，然后点击完成。
3. 设置实体 ID 以更新图书 4567_Book4567_Sheet1。如需设置实体 ID，请在任务的数据映射器部分，点击 entityId，然后在给定字段中输入 6.0。
4. 在任务的数据映射器部分中，点击 OpenDataMapping 编辑器，然后在 field: 中输入类似于以下内容的值

    
      {
       "Name": "updated",
       "Type": "newupdate"
     }
     

运行此示例会在连接器任务的 connectorOutputPayload 输出变量中返回类似于以下内容的响应：

 
  {   
  "Id": 6.0
  }
  

向 Google Cloud 社区寻求帮助

您可以在 Google Cloud 社区的 Cloud 论坛中发布您的问题以及讨论此连接器。

后续步骤

• 了解如何暂停和恢复连接。
• 了解如何监控连接器使用情况。
• 了解如何查看连接器日志。