Office 365

借助 Office365 连接器，您可以连接到 Office365 实例并执行受支持的操作。

准备工作

在使用 Office365 连接器之前，请先完成以下任务：

• 在您的 Google Cloud 项目中：
  • 启用以下服务：
    • secretmanager.googleapis.com (Secret Manager API)
    • connectors.googleapis.com (Connectors API)

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

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

配置连接器

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

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

   转到“连接”页面

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

      连接器支持的区域包括：

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

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

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

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

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

   注意：仅当您是随用随付客户时，才能自定义连接节点值。
   8. Azure 租户：用于访问数据的 Microsoft 在线租户。如果未指定，系统将使用您的默认租户。
   9. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
   10. 点击下一步。
5. 在身份验证部分中，输入身份验证详细信息。
   1. 选择身份验证类型，然后输入相关详细信息。

      Office365 连接支持以下身份验证类型：

      • OAuth 2.0 授权代码授权

   如需了解如何配置这些身份验证类型，请参阅配置身份验证。

   2. 点击下一步。
6. 查看：查看您的连接和身份验证详细信息。
7. 点击创建。

配置身份验证

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

• OAuth 2.0 授权码授予
  • 访问令牌：通过基于 auth-code-flow 的连接对请求进行身份验证时所用的访问令牌。
  • 客户端 ID：请求访问令牌时所用的客户端 ID。
  • 客户端密钥：请求访问令牌时所用的客户端密钥。

实体、操作和动作

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

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

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

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

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

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

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

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

系统限制

Office365 连接器每秒可处理 1 个事务， 每节点， 并throttles任何事务 。 默认情况下，集成连接器会为连接分配 2 个节点（以提高可用性）。

如需了解适用于集成连接器的限制，请参阅限制。

注意：Integration Connectors 节点的数量会动态地自动扩缩 根据您的使用情况但是，如果您想为大量存储卷预留容量， 等待自动扩缩，您可以调整连接的最小节点值。连接处理越多事务就需要越多节点。反之，节点数量越少 如果连接处理的事务较少，则必需项。如需配置节点值，请执行以下操作：

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

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

操作

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

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

CancelEvent 操作

此操作可让您取消活动。

cancelEvent 操作的输入参数

参数名称	数据类型	必需	说明
EventId	字符串	是	事件的 ID。
UserId	字符串	否	用户的 ID。
UserPrincipalName	字符串	否	需要为其分配许可的用户名。
评论	字符串	否	要包含的评论。

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

MoveMail 操作

通过此操作，您可以移动电子邮件。

MoveMail 操作的输入参数

参数名称	数据类型	必需	说明
MessageId	字符串	是	电子邮件 ID。
DestinationId	字符串	是	要将电子邮件移到的目标文件夹的 ID。

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

AssignLicense 操作

执行此操作后，您就可以分配许可了。

AssignLicense 操作的输入参数

参数名称	数据类型	必需	说明
UserId	字符串	否	需要分配许可的用户的 ID。
UserPrincipalName	字符串	否	需要为其分配许可的用户名。
AddLicenseSkuId	字符串	否	SKU 的唯一标识符。
DisabledPlans	字符串	否	一系列以英文逗号分隔的方案 已停用。
RemoveLicenses	字符串	否	一系列以英文逗号分隔的 ID，用于标识要移除的许可。

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

ForwardEvent 操作

此操作可让您转发活动。

ForwardEvent 操作的输入参数

参数名称	数据类型	必需	说明
EventId	字符串	是	事件的 ID。
UserId	字符串	否	用户的 ID。
UserPrincipalName	字符串	否	需要分配许可的用户名。
评论	字符串	否	要包含的评论。
ToRecipients	字符串	是	以英文分号分隔的收件人电子邮件列表。

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

UploadFile 操作

通过此操作，您可以上传文件。

UploadFile 操作的输入参数

参数名称	数据类型	必需	说明
FileName	字符串	否	您需要将内容上传到的文件的名称。
LocalFile	字符串	否	包含要上传的内容的本地文件。
ContentStream	字符串	否	当未指定 localpath 或 folderpath 时，要上传的内容作为输入流。
ParentId	字符串	是	当前项所在文件夹的 ID。
内容	字符串	否	要上传的文件内容。

例如，关于如何配置 UploadFile 操作， 请参阅操作示例。

DownloadFile 操作

通过此操作，您可以下载文件。

DownloadFile 操作的输入参数

参数名称	数据类型	必需	说明
FileId	字符串	是	您要下载的文件的 ID。
DownloadTo	字符串	否	文件的存储位置。
编码	字符串	否	FileData 输入编码类型。允许的值为 NONE、BASE64，默认值为 BASE64。
FileStream	字符串	否	写入文件数据的输出流实例。仅在 未指定 DownloadTo。

例如，关于如何配置 DownloadFile 操作， 请参阅操作示例。

CreateFolder 操作

通过此操作，您可以创建文件夹。

CreateFolder 操作的输入参数

参数名称	数据类型	必需	说明
ParentId	字符串	否	当前内容所在文件夹的 ID。
FolderName	字符串	是	要创建的文件夹的名称。

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

SendMail 操作

通过此操作，您可以发送电子邮件。

SendMail 操作的输入参数

参数名称	数据类型	必需	说明
ToRecipients	字符串	否	电子邮件的收件人。
内容	字符串	否	电子邮件内容。
主题	字符串	否	电子邮件主题。
ID	字符串	否	要发送的消息的 ID（可选）。用户可以使用现有电子邮件 ID，也可以根据需要填写其他字段以发送新电子邮件。
附件	字符串	否	文件附件。请按以下格式指定文件附件： filename1,filecontent1;filename2,filecontent2。每个文件的内容 可以是 BASE64 数据，也可以是前面带有 @ 字符的本地文件的路径。
FileName	字符串	否	收件人 请按以下顺序指定收件人。
LocalFile	字符串	否	包含附件内容的文件。
ContentBytes	字符串	否	编码为 BASE64 的附件内容。
CCRecipients	字符串	否	抄送收件人的值（以英文分号分隔）。
SenderEmail	字符串	否	需要发送代表谁的电子邮件地址。如果您符合以下情况，请设置此项 代表其他用户的账号发送电子邮件。
FromEmail	字符串	否	需要发送电子邮件的用户的电子邮件地址。设置此项 如果您想从其他用户的账号发送电子邮件。
ContentType	字符串	否	电子邮件正文的内容类型。允许的值为文本、html。 默认值为 text。

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

ForwardMail 操作

通过此操作，您可以转发电子邮件。

ForwardMail 操作的输入参数

参数名称	数据类型	必需	说明
MessageId	字符串	是	电子邮件的 ID。
ToRecipients	字符串	是	以英文分号分隔的收件人电子邮件列表。
评论	字符串	否	除原始消息以外的内容。

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

DownloadEmail 操作

通过此操作，您可以下载电子邮件。

DownloadEmail 操作的输入参数

参数名称	数据类型	必需	说明
MessageId	字符串	是	您要下载的消息的 ID。
编码	字符串	否	文件数据输入编码类型。
DownloadTo	字符串	否	文件的存储位置。
FileStream	字符串	否	一个输出流实例，其中应写入文件数据。该值为 仅在未提供 DownloadTo 时使用。

例如，如何配置 DownloadMail 操作，请参阅操作示例。

DownloadAttachments 操作

通过此操作，您可以下载电子邮件的附件。

DownloadAttachments 操作的输入参数

参数名称	数据类型	必需	说明
MessageId	字符串	是	您要从中获取附件的电子邮件的 ID。
编码	字符串	否	FileData 输入编码类型。 允许的值为 NONE、BASE64。
DownloadTo	字符串	否	附件的存储位置。如果未指定，则返回附件的字节内容。如果指定了 MessageId，则此值为必填值。
AttachmentId	字符串	否	要下载的附件的 ID。如果未指定，则返回电子邮件的所有附件。
UserId	字符串	否	用户的 ID。只有在经过身份验证的用户拥有管理员权限时，此操作才有效。
FileStream	字符串	否	输出流的实例，用于写入文件数据。仅在未提供 DownloadTo 时使用。

例如，如何配置 DownloadAttachments 操作，请参阅操作示例。

操作示例

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

示例 - 取消活动

以下示例会取消具有指定 ID 的事件。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 CancelEvent 操作，然后点击完成。
3. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段：

   {
   "EventId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-GAAA=",   
   "Comment": "Canceled due to rain"
   }

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

[{
"Status": "Success"
}]

示例 - 分配和移除许可

此示例为指定用户分配和移除许可。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 AssignLicense 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "UserID": "ee58217f-b22e-4300-a876-53db3c71a87b",   
   "AddLicenseSkuId": "c42b9cae-ea4f-4ab7-9717-81576235ccac",   
   "RemoveLicenses": "c42b9cae-ea4f-4ab7-9717-81576235ccac"
   }

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

[{
"Status": "Success"
}]

示例 - 转发事件

此示例转发事件。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 ForwardEvent 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "EventId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-PKBwAhfASdetQfTZ3pESzwWnAbAAAAAAENAAAhfASdetQfTZ3pESzwWnAbAAA_CxGjAAA=",   
   "Comment": "forwarded due to rain",   
   "ToRecipients": "[e-mail]"
   }

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

[{
"Status": "Success"
}]

示例 - 上传文件

此示例上传文件。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 UploadFile 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "FileName": "Document1234.docx",   
   "ParentId": "01VCU572N6Y2GOVW7725BZO354PWSELRRZ",   
   "Content": "test"
   }

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

 [{
"Id": "01VCU572JX6F3L3NKLQVB2BXETRHLEAUAY",   
"@test.context": "https://example.com/v1.0/$metadata#users('7954f490-5a43-083fc215362a')/drive/items('01VCU5BZO354PWSELRRZ')/test/$entity",   
"@example.downloadurl": "https://example.com/test/admin123/_layouts/15/download.aspx?UniqueId=bd76224r7-4........
"Status": "Success"
}] 

示例 - 下载文件

本示例会下载文件。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 DownloadFile 操作，然后点击完成。
3. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段：

   {
   "FileId": "01VCU572LDCGQYZOSMHZDZGN5HCXS5P6EP"
   }

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

[{
"Status": "Success",
"FileData": "UEsDBBQAAAAIAEoTdVdSWj6GTAEAABoFAAATAAAAWNdLnhtbLWUTU7DMBCFr2J"
}]

示例 - 创建文件夹

本示例将创建一个文件夹。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 CreateFolder 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "ParentId": "01VCU572N6Y2GOVW7725BZO354PWSELRRZ",   
   "FolderName": "outbox1234"
   }

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

[{
"Status": "Success"
}]

示例 - 发送电子邮件

此示例会向指定的收件人发送电子邮件。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 SendMail 操作，然后点击完成。
3. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段：

   {
   "ToRecipients": "[e-mail]",   
   "Content": "Testing",   
   "Subject": "Test subject",   
   "FileName": "Google"
   }

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

[{
"Status": "Success"
}]

示例 - 转发电子邮件

以下示例会转发电子邮件。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 ForwardMail 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "MessageId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-PKBwAhfASdetQfTpESzwWnAbAAA0sITVAAA=",   
   "ToRecipients": "[e-mail]",   
   "Comment": "forwarded message"
   }

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

[{
"Status": "Success"
}]

示例 - 下载电子邮件

此示例会下载电子邮件。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 DownloadEmail 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "MessageId": "fTZ3pESzwWnAbAAAAAAEJAAAhfASdetQfTZ3pESzwWnAbAAA0sITVAAA="
   }

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

[{
"Status": "Success",   
"FileData": "RnJvbTogRk5VIExOVSA8YWRtaW4xMjNANzNzY21nLm9ubWljcm9zb2Z0LmNvbT4NClRvOiB0ZXN0IDx0ZXN0.......
}]

示例 - 下载附件

本示例下载附件。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 DownloadAttachments 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   {"MessageId": "PKBwAhfASdetQfTZ3pESzwWnAbAAAAAAEJAAAhfASdetQfTZ3pESzwWnAbAAA0sITWAAA=",   
   "DownloadTo": "My files/Office355/reports/"}
   }

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

[{
"Id": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGTWAAABEgAQAF3EBDrnTc1Cj8akAYrJjdM=",
"Name": "demoattachment.docx",
"ContentBytes": "UEsDBBQAAAAIALskYlcppqeszQEAAHQJAAATAAAAWAAAI3RyYXNoXS8wMDAwLmRhdP........",
"LastmodifiedDatetime": "2023-11-21T10:09:09Z",
"ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"FileData": null,
"json:repeatelementorder#": null,
"size": "23575",
"isinline": "false
}]

在集成中使用 Office365 连接

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

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

向 Google Cloud 社区寻求帮助

您可以在 Google Cloud 中发布问题和讨论此连接器 Cloud 论坛。

后续步骤

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