此页面由 Cloud Translation API 翻译。

SharePoint

借助 SharePoint 连接器，您可以管理 SharePoint 中的文件、文件夹和附件。

支持的版本

此连接器支持 Windows SharePoint Services 3.0、Microsoft Office SharePoint Server 2007 及更高版本和 SharePoint Online。

准备工作

在 Google Cloud 项目中，执行以下任务：

确保已设置网络连接。如需了解相关信息，请参阅网络连接。
向配置连接器的用户授予 roles/connectors.admin IAM 角色。
向您要用于连接器的服务账号授予 roles/secretmanager.viewer 和 roles/secretmanager.secretAccessor IAM 角色：
启用 secretmanager.googleapis.com (Secret Manager API) 和 connectors.googleapis.com (Connectors API)。如需了解详情，请参阅启用服务。

创建 SharePoint 连接

一个连接需专用于一个数据源。这意味着，如果您有许多数据源，则必须为每个数据源创建单独的连接。如需创建连接，请执行以下操作：

在 Cloud 控制台中，进入 Integration Connectors > 连接页面，然后选择或创建一个 Google Cloud 项目。
转到“连接”页面
点击 + 新建以打开创建连接页面。
在位置部分中，从区域列表中选择一个位置，然后点击下一步。
如需查看所有受支持区域的列表，请参阅位置。
在连接详情部分中，完成以下操作：
1. 从连接器列表中选择 SharePoint。
2. 从连接器版本列表中选择一个连接器版本。
3. 在连接名称字段中，输入连接实例的名称。连接名称可以包含小写字母、数字或连字符。名称必须以字母开头，以字母或数字结尾，且不得超过 49 个字符。
4. （可选）输入连接实例的说明。
5. 您可以选择启用 Cloud Logging，然后选择日志级别。默认情况下，日志级别设置为 Error。
6. 在服务账号字段中，选择具有所需角色的账号。
7. （可选）配置连接节点设置：
  - 节点数下限：输入连接节点数下限。
  - 节点数上限：输入连接节点数上限。
  节点是处理事务的连接单元（或副本）。连接处理越多事务就需要越多节点，相反，处理越少事务需要越少节点。如需了解节点如何影响连接器价格，请参阅连接节点的价格。如果未输入任何值，则默认情况下，节点数下限设置为 2（以便提高可用性），节点数上限设置为 50。
8. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
9. 点击下一步。

在目标部分中，输入要连接到的远程主机（后端系统）的详细信息，然后点击下一步。

在目标类型字段中，选择目标类型。例如，主机地址为 https://<SITE_NAME>.sharepoint.com。

如需指定目标主机名或 IP 地址，请选择主机地址，然后在主机 1 字段中输入相应地址。
如需建立专用连接，请选择端点连接，然后从端点连接列表中选择所需的连接。
注意： 如需了解如何创建端点连接，请参阅 PSC 服务连接和端点连接。创建端点连接后，它将显示在端点连接列表中。

如果要与后端系统建立公共连接以提高安全性，您可以考虑为连接配置静态出站 IP 地址，然后将防火墙规则配置为仅将特定静态 IP 地址列入许可名单。

若要输入其他目标，请点击 + 添加目标。

在身份验证部分中，输入身份验证详细信息。
1. 选择身份验证类型，然后输入相关详细信息。
  SharePoint 连接支持以下身份验证类型：
  - Windows 凭据。如果您使用的是本地版 SharePoint，请选择此选项。
  - AzureAD。如果您使用的是 SharePoint 在线版，请选择此选项。
  - 使用 JWT 不记名令牌的 OAuth 2.0 客户端凭据。如果您使用 OAuth 2.0 客户端凭据和 JWT 不记名令牌进行身份验证，请选择此选项。
  - 使用客户端密钥的 OAuth 2.0 客户端凭据。如果您使用 OAuth 2.0 客户端凭据和客户端密钥进行身份验证，请选择此选项。
2. 点击下一步。
在查看部分中，查看您的连接和身份验证详细信息。
点击创建。

配置身份验证

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

Windows 凭据身份验证类型

如需启用 Windows 凭据身份验证类型，您必须完成以下步骤：

配置 PSC 并创建端点连接

创建以 SharePoint 托管 IP 为基础的实例组。
创建内部直通式网络负载均衡器，并将您创建的实例组用作后端。TCP 内部负载均衡器必须启用全球访问权限。
在 Private Service Connect 中发布负载均衡器。发布负载均衡器后，系统会生成服务连接。
发布服务并指定您创建的负载均衡器。
使用服务连接创建端点连接。
创建端点连接后，使用端点连接 IP 创建 SharePoint 连接。

如需详细了解如何创建端点连接，请参阅创建端点连接。

在 Google Cloud中指定 Windows 凭据详细信息

在 Integration Connectors 中创建连接时，您必须指定以下详细信息：

在身份验证部分中，选择 Windows 凭据作为身份验证类型，然后输入以下详细信息：

用户名：输入用户名。
密码：选择相应密码。
密文版本：输入密文版本。

Windows 凭据连接类型

下表列出了 Windows 凭据连接类型的示例配置值。

字段名称	详细信息
区域	us-central1
连接器	SharePoint
连接器版本	1
连接名称	sharepoint-staging-psc
服务账号	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
节点数下限	2
节点数上限	50
目标类型	主机地址
主机 1	http://192.0.2.0
端口 1	24
身份验证	Windows 凭据
用户名	USER_NAME
密码	PASSWORD
Secret 版本	1

Azure AD 身份验证类型

如需启用 Azure AD 身份验证类型，您必须完成以下步骤：

注册应用并获取 OAuthClientId 和 OAuthClientSecret

如需注册应用并获取应用的 OAuthClientId 和 OAuthClientSecret，请执行以下操作：

登录 Azure 门户。
在 Azure 服务中，依次选择应用注册和新注册。
输入应用名称，然后选择任何 Microsoft Entra ID 租户 - 多租户。
点击注册。
创建应用后，前往证书和密钥页面。
为应用创建客户端密钥，并保存客户端密钥值。
前往 API 权限页面。
点击添加权限。
在请求 API 权限 对话框中，从下表中选择 API、类型和权限，以在应用中执行操作。

如需使连接处于有效状态，您必须为 Microsoft Graph API 授予 Sites.Read.All 权限。

API	权限名称	类型
Microsoft Graph	`ConsentRequest.Read.All`	`Application/ Delegated`
Microsoft Graph	`ConsentRequest.ReadWrite.All`	`Application/ Delegated`
Microsoft Graph	`DelegatedAdminRelationship.Read.All`	`Application/ Delegated`
Microsoft Graph	`DelegatedAdminRelationship.ReadWrite.All`	`Application/ Delegated`
Microsoft Graph	`DelegatedPermissionGrant.Read.All`	`Application/ Delegated`
Microsoft Graph	`DelegatedPermissionGrant.ReadWrite.All`	`Application/ Delegated`
Microsoft Graph	`Files.Read.All`	`Application/ Delegated`
Microsoft Graph	`Files.ReadWrite.All`	`Application/ Delegated`
Microsoft Graph	`Sites.FullControl.All`	`Application/ Delegated`
Microsoft Graph	`Sites.Manage.All`	`Application/ Delegated`
Microsoft Graph	`Sites.Read.All`	`Application/ Delegated`
Microsoft Graph	`Sites.ReadWrite.All`	`Application/ Delegated`
Microsoft Graph	`Sites.Selected`	`Application/ Delegated`
Microsoft Graph	`TermStore.Read.All`	`Application/ Delegated`
Microsoft Graph	`TermStore.ReadWrite.All`	`Application/ Delegated`
Microsoft Graph	`User.Export.All`	`Application/ Delegated`
Microsoft Graph	`User.Read`	`Delegated`
Microsoft Graph	`User.Read.All`	`Application/ Delegated`
Microsoft Graph	`User.ReadWrite.All`	`Application/ Delegated`
SharePoint	`EnterpriseResource.Read`	`Delegated`
SharePoint	`EnterpriseResource.Write`	`Delegated`
SharePoint	`Project.Read`	`Delegated`
SharePoint	`Project.Write`	`Delegated`
SharePoint	`ProjectWebApp.FullControl`	`Delegated`
SharePoint	`ProjectWebAppReporting.Read`	`Delegated`
SharePoint	`TaskStatus.Submit`	`Delegated`

保存更改。
如果您已选择使用需要管理员同意的权限，则可以在 API 权限页面上从当前租户授予这些权限。
如需添加范围，请前往公开 API 部分，添加 AllSites.Manage, Sites.FullControl.All 范围，然后选择哪些人可以控制（管理员和用户）。
点击保存。

在 Google Cloud中指定凭据

在 Integration Connectors 中创建连接时，您必须指定以下详细信息：

在身份验证部分中，选择 AzureAD 作为身份验证类型，然后输入以下详细信息：

客户端 ID：输入用于请求访问令牌的客户端 ID。
范围：输入以英文逗号分隔的所需范围列表。例如 Sites.FullControl.All
客户端密钥：输入包含您创建的关联应用的客户端密钥的密文。
密钥版本：所选密钥的密钥版本。
授权网址：创建 OAuth 客户端时生成的授权网址。以以下格式输入网址：https://login.microsoftonline.com/TENANT_IDENTIFIER/oauth2/v2.0/authorize?prompt=consent。例如 https://login.microsoftonline.com/9byyyyyyyyy8112/oauth2/v2.0/authorize?prompt=consent。

在 Google Cloud中授权连接

在“连接”页面中，找到新创建的连接。
新连接器的状态将为需要授权。
点击需要授权。
系统会显示修改授权窗格。
将重定向 URI 值复制到外部应用。如需了解详情，请参阅向应用添加重定向网址。
验证授权详细信息。
点击授权。
如果授权成功，系统会在“连接”页面中将连接状态设置为有效。

将重定向网址添加到您的应用

在 Azure 门户中，依次点击 Azure 服务 > 应用注册。
点击您的应用名称。
点击“添加重定向 URI”。
点击添加平台。
在网页对话框中，粘贴您在 Google Cloud中授权连接时复制的重定向 URI。

Azure AD 连接类型

下表列出了 Azure AD 连接类型的示例配置值：

字段名称	详细信息
区域	us-central1
连接器	SharePoint
连接器版本	1
连接名称	sharepoint-google-cloud-con
服务账号	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
节点数下限	2
节点数上限	50
目的地类型	主机地址
主机 1	http://z8**.sharepoint.com
身份验证	AzureAD
Client-ID	CLIENT_ID
范围	Sites.FullControl.All
客户端密钥	CLIENT_SECRET
密钥版本	1
授权网址	https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/authorize

OAuth 2.0 - 客户端凭据与 JWT 不记名身份验证类型

如需启用 OAuth 2.0 - 客户端凭据（包含 JWT 不记名令牌）身份验证类型，您必须完成以下步骤：

创建证书

在计算机上创建一个空文件夹。
在该文件夹中创建一个文本文件。
从通过 Azure AD 仅限应用授予访问权限页面复制 PowerShell 脚本，然后将其粘贴到文本文件中。
将该文本文件重命名为以下名称：Create-SelfSignedCertificate.ps1。
在该文件夹中运行 Windows PowerShell。
前往包含文本文件的目录。
复制以下命令： .\Create-SelfSignedCertificate.ps1 -CommonName "CERTIFICATE_NAME" -StartDate 2022-09-25 -EndDate 2023-10-25
为 CERTIFICATE_NAME 输入一个唯一名称。将 StartDate 更改为当前日期，并将 EndDate 更改为您选择的日期。
将复制的命令（包含您的更改）粘贴到 Windows PowerShell 中，然后按 Enter 键。
Windows PowerShell 提示输入密码以保护私钥。请务必保存密码以供日后使用。

Windows PowerShell 会创建两个文件：MyCertificate.pfx 和 MyCertificate.cer。

将证书上传到 Azure 门户

登录 Azure 门户，然后指定以下详细信息来注册新应用：
- 名称：输入应用的名称。
- 支持的账号类型：选择仅此组织目录中的账号（仅限账号名称 - 单租户）。
依次前往 API 权限 > 添加权限 > 请求 API 权限 > SharePoint。
选择应用权限，然后添加所需的权限。
选择授予管理员同意权限，然后选择是。
创建应用后，前往证书和密钥部分。
选择上传证书，然后从您的计算机上传 CER 证书。上传完毕后，选择添加。
请勿在应用中添加客户端密钥，因为这会干扰基于证书的身份验证流程。
前往清单，找到 KeyCredentials，然后将 customKeyIdentifier 复制为指纹。您稍后会用到此值。您现在已注册应用并关联证书。

获取私钥

您可以使用 OpenSSL 将 PFX 文件转换为 PEM 文件，从而获取私钥。

在命令提示符下，前往包含 PFX 文件的文件夹，然后运行以下命令： openssl pkcs12 -in MyCertificate.pfx -out MyCertificate.pem -nodes
输入您在证书创建过程中使用的 PFX 密码。
在文本编辑器中打开 PEM 文件，然后复制整个文本（即您的私钥）。

完成设置

从 Azure 门户中新注册的应用复制客户端 ID 和租户 ID。
使用 SharePoint 列表服务正文身份验证，并使用以下凭据登录：

客户端 ID
租户 ID
私钥
指纹（私钥密码）

在 Google Cloud中指定 OAuth 2.0 JWT 不记名凭据

在 Integration Connectors 中创建连接时，您必须指定以下详细信息：

在身份验证部分中，选择 OAuth 2.0 客户端凭据（包含 JWT 不记名令牌）作为身份验证类型，然后输入以下详细信息：

在客户端 ID 字段中，输入用于请求访问令牌的客户端 ID。这是在 Azure 门户中注册应用时生成的使用方密钥。
在私钥字段中，选择包含 PEM 格式私钥文件内容的 Secret Manager 密文。私钥应与提供给连接器的公钥/证书匹配。
在 Secret 版本字段中，选择上述所选 Secret 的版本。
在私钥密码字段中，选择包含私钥文件的密码（短语）的 Secret Manager 密文。使用您在创建证书时设置的用于保护私钥的同一密码。
在 Secret 版本字段中，选择上述所选 Secret 的版本。
在 Azure 租户字段中，输入用于访问数据的 Microsoft 在线租户。

JWT 不记名证书连接类型

下表列出了 OAuth 2.0 JWT 不记名证书连接类型的示例配置值。

字段名称	详细信息
区域	europe-west1
连接器	SharePoint
连接器版本	1
连接名称	sharepoint-jwt-certificate
服务账号	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
节点数下限	2
节点数上限	50
目的地类型	主机地址
主机 1	http://z8**.sharepoint.com
端口 1	****
身份验证	OAuth 2.0-客户端凭据（包含 JWT 不记名令牌）
OAuth 客户端 ID	CLIENT_ID
私钥	键
Secret 版本	1
私钥密码	PASSWORD
Secret 版本	1
Azure 租户	AZURE_TENANT_ID

OAuth 2.0 - 客户端密钥连接类型

如需启用 OAuth 2.0 客户端密钥连接类型，您必须完成以下步骤：

注册插件

使用以下网址前往注册插件页面： https://<SITE_NAME>.SharePoint.com/_layouts/15/appregnew.aspx。
在应用信息部分中，生成客户端 ID 和客户端密钥。
为“名称”“应用网域”和“重定向 URI”指定值。
点击创建。系统会注册该插件，并且 SharePoint 应用会显示已创建的信息。

向插件授予权限

使用以下网址导航到 SharePoint 网站： https://<SITE_NAME>-admin.sharepoint.com/_layouts/15/appinv.aspx。系统会将您重定向到授予权限页面。
在 App ID（应用 ID）字段中，输入您之前生成的客户端 ID，然后点击 Lookup（查询）。系统会填充“标题”“应用网域”和“重定向网址”的值。

以 XML 格式输入以下权限请求：

      <AppPermissionRequests AllowAppOnlyPolicy="true">
      <AppPermissionRequest Scope="http://sharepoint.com/content/tenant" Right="FullControl"/>
      </AppPermissionRequests>

点击创建。SharePoint 应用会显示权限同意对话框。
点击信任。

在 Google Cloud中指定 OAuth 2.0 客户端凭据

在 Integration Connectors 中创建连接时，您必须指定以下详细信息：

在身份验证部分中，选择使用客户端密钥的 OAuth 2.0 客户端凭据作为身份验证类型，然后输入以下详细信息：

在客户端 ID 字段中，输入连接器为您创建的应用提供的客户端 ID。
在客户端密钥字段中，选择包含您创建的关联应用的客户端密钥的 Secret Manager 密文。
在客户端密钥版本字段中，选择客户端密钥的版本。

重新授权（针对授权代码）

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

在“连接”页面中，点击所需的连接。
系统随即会打开连接详情页面。
点击修改以修改连接详情。
在身份验证部分中，验证 OAuth 2.0 - 授权代码详细信息。
如有需要，请进行必要的更改。
点击保存。系统随即会转到连接详情页面。
在身份验证部分中，点击修改授权。系统会显示授权窗格。
点击授权。
如果授权成功，系统会在“连接”页面中将连接状态设置为有效。

客户端凭据连接类型

下表列出了 OAuth 2.0 客户端凭据连接类型的示例配置值。

字段名称	详细信息
区域	europe-west1
连接器	SharePoint
连接器版本	1
连接名称	sharepoint-client-credentials
服务账号	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
节点数下限	2
节点数上限	50
目的地类型	主机地址
主机 1	http://z8**.sharepoint.com
端口 1	****
身份验证	OAuth 2.0 - 使用客户端密钥进行客户端凭据身份验证
客户端 ID	CLIENT_ID
客户端密钥	CLIENT_SECRET
Secret 版本	1

在集成中使用 SharePoint 连接

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

操作

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

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

DeleteAttachment 操作

此操作会删除附件。

DeleteAttachment 操作的输入参数

参数名称	数据类型	必需	说明
ListTitle	字符串	是	列表项的标题。
ItemId	字符串	是	列表项的 ID。
FileName	字符串	是	要从文档库中删除的文件的名称。

CheckInDocument 操作

此操作可让您在文档中签入。

CheckInDocument 操作的输入参数

参数名称	数据类型	必需	说明
RelativeURL	字符串	是	文件夹的相对网址。
DocumentName	字符串	是	要签入的文件的名称。
评论	字符串	否	可选的入住消息。

CheckOutDocument 操作

此操作可让您签出文件。

CheckOutDocument 操作的输入参数

参数名称	数据类型	必需	说明
RelativeURL	字符串	是	文件夹的相对网址。
DocumentName	字符串	是	要签出的文件的名称。

DiscardCheckOutDocument 操作

此操作可让您撤消文件签出。

DiscardCheckOutDocument 操作的输入参数

参数名称	数据类型	必需	说明
RelativeURL	字符串	是	文件夹的相对网址。
DocumentName	字符串	是	需要撤消签出的文件的名称。

CopyDocument 操作

此操作可让您将文件从一个位置复制到另一个位置。

CopyDocument 操作的输入参数

参数名称	数据类型	必需	说明
SourceFileRelativeUrl	字符串	是	源文件的相对网址。
DestFileRelativeUrl	字符串	是	目标文件的相对网址。

UploadDocument 操作

此操作可让您上传文件。

UploadDocument 操作的输入参数

参数名称	数据类型	必需	说明
FileName	字符串	是	要上传的文件的名称。
RelativeUrl	字符串	是	文件夹的相对网址。
内容	字符串	否	要以文件形式上传的内容。
ContentBytes	字符串	否	要上传为文件的字节内容（以 Base64 字符串形式表示）。使用此方法上传二进制数据。
HasBytes	布尔值	否	指定要上传的内容是否为二进制内容。默认值为 `false`。

DownloadDocument 操作

此操作可让您下载文件。

DownloadDocument 操作的输入参数

参数名称	数据类型	必需	说明
RemoteFile	字符串	是	要下载的文件的完整网址。
库	字符串	是	SharePoint 服务器上库的名称。
HasBytes	布尔值	否	指定内容是否应以字节形式下载。默认值为 `false`。

MoveAttachmentOrDocument 操作

此操作可让您将文件从一个文件夹移至另一个文件夹。

MoveAttachmentOrDocument 操作的输入参数

参数名称	数据类型	必需	说明
SourceFileURL	字符串	是	应移动的源文件的网址。
DestinationFolderURL	字符串	是	目标文件夹的网址。

CreateFolder 操作

此操作可让您创建文件夹。

CreateFolder 操作的输入参数

参数名称	数据类型	必需	说明
RelativeURL	字符串	是	文件夹的相对网址。
FolderName	字符串	是	要创建的文件夹的名称。

AddAttachments 操作

此操作可让您添加附件。

AddAttachments 操作的输入参数

参数名称	数据类型	必需	说明
ListTitle	字符串	是	附件列表的名称。
FileName	字符串	是	附件文件的名称。
ItemId	字符串	是	要添加的附件的 ID。
内容	字符串	是	附件的内容。
ContentBytes	字符串	否	要上传为附件的字节内容（以 Base64 字符串形式表示）。使用此方法上传二进制数据。
HasBytes	布尔值	否	指定要上传的内容是否为二进制内容。默认值为 `false`。

DownloadAttachments 操作

此操作可让您下载附件。

DownloadAttachments 操作的输入参数

参数名称	数据类型	必需	说明
RemoteFile	字符串	是	文件的相对网址。
HasBytes	布尔值	否	指定要下载的内容是否为二进制内容。默认值为 `false`。

操作示例

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

示例 - 删除附件

此示例会删除指定的文件。

在 Configure connector task 对话框中，点击 Actions。
选择 DeleteAttachment 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
"ListTitle": "My lists",
"ItemId": "1",
"FileName": "sitepages.txt"
}
```

如果操作成功，DeleteAttachment 任务的 connectorOutputPayload 响应形参将具有类似以下的值：

[{
"Status": "Success"
}]

示例 - 在文档中查看

此示例用于签入文档。

在 Configure connector task 对话框中，点击 Actions。
选择 CheckInDocument 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.txt",
"Comment": "Comment test"
}
```

如果操作成功，CheckInDocument 任务的 connectorOutputPayload 响应形参将具有类似以下的值：

[{
"Status": "Success"
}]

示例 - 签出文件

此示例会检出文件。

在 Configure connector task 对话框中，点击 Actions。
选择 CheckOutDocument 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.txt"
}
```

如果操作成功，CheckOutDocument 任务的 connectorOutputPayload 响应形参将具有类似以下的值：

[{
"Status": "Success"
}]

示例 - 舍弃结账

此示例会还原文件签出。

在 Configure connector task 对话框中，点击 Actions。
选择 DiscardCheckOutDocument 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.docx"
}
```

如果操作成功，DiscardCheckOutDocument 任务的 connectorOutputPayload 响应形参将具有类似以下的值：

[{
"Status": "Success"
}]

示例 - 复制文件

此示例将文件从一个位置复制到另一个位置。

在 Configure connector task 对话框中，点击 Actions。
选择 CopyDocument 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
"SourceFileRelativeUrl": "/Shared Documents/Document.docx",
"DestFileRelativeUrl": "/Shared Documents/TestFolder/Document123.docx"
}
```

如果操作成功，CopyDocument 任务的 connectorOutputPayload 响应形参将具有类似以下的值：

[{
"Status": "Success"
}]

示例 - 上传文本文件

此示例将文本文件上传到指定位置。

在 Configure connector task 对话框中，点击 Actions。
选择 UploadDocument 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
"FileName": "test.txt",
"RelativeUrl": "/Shared Documents/TestFolder",
"Content": "abcd"
}
```

如果操作成功，UploadDocument 任务的 connectorOutputPayload 响应形参将具有类似以下的值：

[{
"Status": "Success"
}]

示例 - 上传二进制文件

此示例将二进制文件上传到指定位置。上传二进制文件时，请将要上传的内容指定为 Base64 编码的字符串。

在 Configure connector task 对话框中，点击 Actions。
选择 UploadDocument 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
"FileName": "test.txt",
"RelativeUrl": "/Shared Documents/TestFolder",
"ContentBytes": "SGVsbG8gd29ybGQK",
"HasBytes": "true"
}
```

如果操作成功，UploadDocument 任务的 connectorOutputPayload 响应形参将具有类似以下的值：

[{
"Status": "Success"
}]

示例 - 下载文件

此示例会下载文件。

在 Configure connector task 对话框中，点击 Actions。
选择 DownloadDocument 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
"RemoteFile": "/TestFolder/test.txt",
"Library": "Shared Documents"
}
```

如果操作成功，DownloadDocument 任务的 connectorOutputPayload 响应形参将具有类似以下的值：

[{
"Success": "True",
"Content": "Test File",
}]

示例 - 下载二进制文件

此示例下载了一个二进制文件。

在 Configure connector task 对话框中，点击 Actions。
选择 DownloadDocument 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
"RemoteFile": "/TestFolder/test1.png",
"Library": "Shared Documents"
"HasBytes": "true"  
}
```

如果操作成功，DownloadDocument 任务的 connectorOutputPayload 响应形参将具有类似以下的值：

[{
"Success": "True",
"ContentBytes": "VGVzdCBGaWxl",
}]

示例 - 从特定网站下载文件

此示例从特定网站下载文件。

在 Configure connector task 对话框中，点击 Actions。
选择 DownloadDocument 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
  "RemoteFile": "	http://z8**.sharepoint.com/sites/SharepointGCS/Docs/SharpointGCS.docx",
  "Library": "Docs",
  "HasBytes": true
}
```

DownloadDocument

connectorOutputPayload

[
  {
    "Success": "True",
    "ContentBytes": "UEsDBAoAAAAAAAAAIQD/////TwEAAE8BAAAQAAAAW3RyYXNoXS8wMDAwLmRhdP////nFmjQeC1QbGmk9o7n0xjiLgudAMOrYQBpOZdZp5/OrWkWbudVPccasL5uVSKun3URrHAxow7iMUm2WSi7nlGy2Mr+sjJxQSrYFcFtDQyo/QSutWhbNcAODEWh14mklzxCS9C5CW3Fmwme/gMKGjGoXlSVyvtDoB+u0A6XtA8bkWTnPNHSvxcepoAKIdsR96imCvxe4MxOWqHWnQkLDyjNMOMrrQeMDF7nOMCCvPlVn5Vd6KlDYnHlW1zLOcQf6WmKl2xN4Z8WBXZfkrJZqPv6yNdWyp8ADRmgTdRSqDkPpQqzvqWj3qpdiRZqSwyBRtfr2kHBumkTNjSi6drBMFMxZEgrktw6ZxuEXcx3v16cXd6k5JVO3kOXMg/HFnH"
  }
]

如需从特定网站下载文件，您必须提供远程文件的完整地址。

示例 - 移动附件

此示例将附件从一个位置移动到另一个位置。

在 Configure connector task 对话框中，点击 Actions。
选择 MoveAttachmentOrDocument 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
"SourceFileURL": "/Shared Documents/test.txt",
"DestinationFolderURL": "/Shared Documents/TestFolder"
}
```

如果操作成功，MoveAttachmentOrDocument 任务的 connectorOutputPayload 响应形参将具有类似以下的值：

[{
"Result": "Success"
}]

示例 - 创建文件夹

此示例在指定位置创建文件夹。

在 Configure connector task 对话框中，点击 Actions。
选择 CreateFolder 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
"RelativeURL": "/Shared Documents/TestFolder",
"FolderName": "TestFolder123"
}
```

如果操作成功，CreateFolder 任务的 connectorOutputPayload 响应形参将具有类似以下的值：

[{
"Id": "110842b7-2393-4f11-9391-3d75214e9fb8",
"Status": "Success"
}]

示例 - 添加附件

此示例将附件添加到指定列表。

在 Configure connector task 对话框中，点击 Actions。
选择 AddAttachments 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
"ListTitle": "My Lists",
"FileName": "TestAttachment2",
"Content": "abcd text",
"ItemId": "1"
}
```

如果操作成功，AddAttachments 任务的 connectorOutputPayload 响应形参将具有类似以下的值：

[{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment2",
"Status": "Success"
}]

示例 - 添加二进制附件

此示例将二进制附件添加到指定列表。

在 Configure connector task 对话框中，点击 Actions。
选择 AddAttachments 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
"ListTitle": "My Lists",
"FileName": "TestAttachment3",
"ContentBytes": "VGVzdCBGaWxl",
"HasBytes": "true",  
"ItemId": "1"
}
```

如果操作成功，AddAttachments 任务的 connectorOutputPayload 响应形参将具有类似以下的值：

[{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment3",
"Status": "Success"
}]

示例 - 下载附件

此示例下载附件。

在 Configure connector task 对话框中，点击 Actions。
选择 DownloadAttachments 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
"RemoteFile": "/Shared Documents/Document.txt"
}
```

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

[{
"Success": "True",
"Content": "Test File",
}]

示例 - 下载二进制附件

此示例下载二进制附件。

在 Configure connector task 对话框中，点击 Actions。
选择 DownloadAttachments 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
"RemoteFile": "/Shared Documents/Document.docx",
"HasBytes": "true"
}
```

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

[{
"Success": "True",
"ContentBytes": "VGVzdCBGaWxl",
}]

实体操作示例

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

示例 - 列出所有文件

此示例列出了 Files 实体中的所有文件。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择 Files。
选择 List 操作，然后点击完成。
或者，您可以在连接器任务的任务输入部分中，通过指定过滤条件子句来过滤结果集。您还可以使用逻辑运算符指定多个过滤条件。

示例 - 获取列表

此示例从 My Lists 实体获取具有指定 ID 的列表。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择 My Lists。
选择 Get 操作，然后点击完成。
在连接器任务的任务输入部分，点击 EntityId，然后在默认值字段中输入 3。
在此示例中，3 是 My Lists 实体的某个主键值。

示例 - 创建记录

此示例会在 My Lists 实体中创建一条记录。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择 My Lists。
选择 Create 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
"AuthorId": 11.0, 
"BaseName": "3_",
"Attachments": false,
"Title": "Created List New"
}
```
如果集成成功，连接器任务的 connectorOutputPayload 字段将具有类似以下的值：
```
[{
"ID": 3.0
}]
```

示例 - 删除记录

此示例会删除 My Lists 实体中具有指定 ID 的记录。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择 My Lists。
选择 Delete 操作，然后点击完成。
在连接器任务的任务输入部分，点击 entityId，然后在默认值字段中输入 2。

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

向 Google Cloud 社区寻求帮助

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

后续步骤

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