Dropbox

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

准备工作

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

• 在您的 Google Cloud 项目中：
  • 确保已设置网络连接。如需了解网络模式，请参阅网络连接。
  • 向配置连接器的用户授予 roles/connectors.admin IAM 角色。
  • 将以下 IAM 角色授予您要用其来使用连接器的服务账号：
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    服务账号是一种特殊类型的 Google 账号，用于表示需要验证身份并获得授权以访问 Google API 数据的非人类用户。如果您没有服务账号，则必须创建一个服务账号。连接器和服务账号必须属于同一项目。如需了解详情，请参阅创建服务账号。

  • 启用以下服务：
    • secretmanager.googleapis.com (Secret Manager API)
    • connectors.googleapis.com (Connectors API)

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

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

配置连接器

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

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

   转到“连接”页面

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

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

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

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

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头，以字母或数字结尾。
      • 连接名称不能超过 49 个字符。
   4. （可选）输入连接实例的说明。
   5. 服务账号：选择具有所需角色的服务账号。
   6. （可选）配置连接节点设置：
      • 节点数下限：输入连接节点数下限。
      • 节点数上限：输入连接节点数上限。

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

   注意：仅当您是随用随付客户时，才能自定义连接节点值。
   7. 模拟用户 ID：可以选择指定要模拟的用户 ID。
   8. 模拟用户模式：可选择指定用户模拟的类型。类型应该是用户模式还是管理员模式。
   9. Include Sub Directories：可选。如果您想在列出文件和文件夹时包含子目录，请使用此选项。
   10. Include Team Resources：可选。如果您想包含团队文件和文件夹，请选择此选项。
   11. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
   12. 点击下一步。
5. 在身份验证部分中，输入身份验证详细信息。
   1. 选择身份验证类型，然后输入相关详细信息。

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

      • OAuth 2.0 授权代码授予

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

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

配置身份验证

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

• OAuth 2.0 授权代码授予
  • 客户端 ID：请求访问令牌时所用的客户端 ID。
  • 范围：Dropbox 权限门户中所需范围的逗号分隔列表。
  • 客户端密钥：请求访问令牌时所用的客户端密钥。

实体、操作和动作

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

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

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

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

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

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

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

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

系统限制

Dropbox 连接器每秒每个节点可处理 18 笔交易，并会限制超出此限额的任何交易。默认情况下，Integration Connectors 会为连接分配 2 个节点（以提高可用性）。

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

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

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

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

操作

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

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

CopyResource 操作

此操作可让您将文件或文件夹复制到用户 Dropbox 中的其他位置。

CopyResource 操作的输入参数

参数名称	数据类型	必需	说明
From_Path	字符串	是	要复制或移动的用户 Dropbox 中的路径。
To_Path	字符串	是	用户 Dropbox 中复制资源的目标路径。
自动重命名	字符串	否	如果存在冲突，让 Dropbox 服务器尝试自动重命名文件以避免冲突。此字段的默认值为 False。
Allow_Ownership_Transfer	字符串	否	允许所有者移动内容，即使这会导致所移动内容的所有权发生转移。这不适用于复制的内容。此字段的默认值为 False。
ObjectPathsAggregate	字符串	否	表示对象路径的汇总。也可以是 #TEMP 表的名称。

如需查看有关如何配置 CopyResource 操作的示例，请参阅操作示例。

CreateFolder 操作

此操作可让您在指定路径中创建文件夹。

CreateFolder 操作的输入参数

参数名称	数据类型	必需	说明
路径	字符串	是	要在用户的 Dropbox 中创建的路径。
AutoRename	布尔值	否	如果存在冲突，让 Dropbox 服务器尝试自动重命名文件夹以避免冲突。 默认值为 false。
ForceAsync	布尔值	否	是否强制异步创建。仅在使用 ObjectPathsAggregate 时可用。 默认值为 false。
ObjectPathsAggregate	字符串	否	表示路径的 JSON 汇总。也可以是 #TEMP 表的名称。

如需查看有关如何配置 CreateFolder 操作的示例，请参阅操作示例。

DeleteResource 操作

此操作可让您删除指定路径中的文件或文件夹。如果该路径是文件夹，系统也会删除其所有内容。

DeleteResource 操作的输入参数

参数名称	数据类型	必需	说明
路径	字符串	是	文件或文件夹的唯一标识符。
ObjectPathsAggregate	字符串	否	表示对象路径的汇总。也可以是 #TEMP 表的名称。

如需查看有关如何配置 DeleteResource 操作的示例，请参阅操作示例。

MoveResource 操作

将文件或文件夹移动到用户 Dropbox 中的其他位置。如果源路径是一个文件夹，则其所有内容都将被移动。请注意，我们目前不支持仅更改大小写的重命名。

MoveResource 操作的输入参数

参数名称	数据类型	必需	说明
From_Path	字符串	是	要复制或移动的用户 Dropbox 中的路径。
To_Path	字符串	是	用户 Dropbox 中的目标路径。
自动重命名	字符串	否	如果存在冲突，让 Dropbox 服务器尝试自动重命名文件以避免冲突。此字段的默认值为 False。
Allow_Ownership_Transfer	字符串	否	允许所有者移动内容，即使这会导致所移动内容的所有权发生转移。这不适用于复制的内容。此字段的默认值为 False。
ObjectPathsAggregate	字符串	否	表示对象路径的汇总。也可以是 #TEMP 表的名称。

如需查看有关如何配置 MoveResource 操作的示例，请参阅操作示例。

RenameResource 操作

此操作可让您通过提供路径和新名称来重命名资源。

RenameResource 操作的输入参数

参数名称	数据类型	必需	说明
路径	字符串	是	要重命名的资源的路径。示例：/myFolder/sample.txt
NewName	字符串	是	资源的名称。示例：sampleDocument.txt

如需查看有关如何配置 RenameResource 操作的示例，请参阅操作示例。

UnshareFolder 操作

此操作可让您取消共享文件夹。需要 sharing.write 范围。

UnshareFolder 操作的输入参数

参数名称	数据类型	必需	说明
FolderId	字符串	是	要取消共享的共享文件夹的 ID。
LeaveCopy	字符串	否	如果为 true，则此共享文件夹的成员在取消共享后将获得此文件夹的副本。 默认值为 false。

如需查看有关如何配置 UnshareFolder 操作的示例，请参阅操作示例。

DownloadFile 操作

此操作可让您下载文件。需要 files.content.read 范围。

DownloadFile 操作的输入参数

参数名称	数据类型	必需	说明
ID	字符串	是	要下载的文档的 ID。
修订版本	字符串	否	要下载的文档的修订版本，例如“rev:a1c10ce0dd78”。
路径	字符串	否	要下载的文件或文件夹的路径。
AsZip	布尔值	否	以 ZIP 格式下载文件夹。必须设置为 true 才能下载文件夹。
FileStream	字符串	否	用于写入文件数据的输出流的实例。仅在未设置 DownloadTo 时使用。
DownloadTo	字符串	否	用于下载文件的文件夹路径。
FileType	字符串	是	文件类型（文件或纸张）

如需查看有关如何配置 DownloadFile 操作的示例，请参阅操作示例。

操作示例

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

示例 - 复制资源

以下示例展示了如何将具有指定路径的资源复制到其他路径：

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

   {
     "From_Path": "/DropboxFolder/pptxFile.pptx",
     "To_Path": "/DropBoxFolder2/Folder/pptFile.pptx"
   }

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

[ { "Success": "true", "metadata_.tag": "file", 
  "metadata_name": "pptxFile.pptx", 
  "metadata_path_lower": "/testingdropboxupdated/abcde/pptxfile.pptx", 
  "metadata_path_display": "/TestingDropBoxUpdated/abcde/pptxFile.pptx", 
  "metadata_parent_shared_folder_id": "3204685267", "metadata_id": "id:8-07A6kHAoIAAAAAAAAC1w",
  "metadata_client_modified": "2024-06-13T11:06:37Z", "metadata_server_modified": "2024-07-12T10:19:02Z",
  "metadata_rev": "61d0a3560ecb5bf039dd3", "metadata_size": "17052", 
  "metadata_sharing_info_read_only": "false", "metadata_sharing_info_parent_shared_folder_id": "3204685267",
  "metadata_sharing_info_modified_by": "dbid:AACVLctlrEo-ouTSxUVSTi0loZCSZKc933A", 
  "metadata_is_downloadable": "true", 
  "metadata_content_hash": "0234f7d4eaf914cb276716c8b2a24e24655d1f6f39ee549207e33a4255e2fba2" } ]

示例 - 创建文件夹

以下示例展示了如何在指定路径中创建文件夹：

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

   {
     "Path": "/TestDrobBoxFolder/newFolder"
   }

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

[ { "Id": "id:8-07A6kHAoIAAAAAAAAC2Q" } ]

示例 - 删除资源

以下示例展示了如何删除资源：

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

   {
     "Path": "/TestingDropBox/FolderToBeDeletedName"
   }

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

[{
"Status": "Success"
}]

示例 - 移动资源

以下示例展示了如何移动资源：

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

   {
     "From_Path": "/TestDropBoxFolder/Folder1/dummypdf2.pdf",
     "To_Path": "/EmptyFolder/Folder1/dummypdf2.pdf"
   }

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

[{
  "Status": "Success"
  }]

示例 - 重命名资源

以下示例展示了如何重命名资源：

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

   {
     "Path": "/TestDropBox/abcd",
     "NewName": "abcded"
   }

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

[{
"Status": "Success"
}]

示例 - 取消共享文件夹

以下示例展示了如何取消共享文件夹：

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

   {
     "FolderId": "3336772979"
   }

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

[{
"Status": "Success"
}]

示例 - 下载文件

以下示例展示了如何下载文件：

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

   {
     "Id": "id:8-07A6kHAoIAAAAAAAABcg",
     "FileType": "file"
   }

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

[ { "Success": "true", "Name": "license.txt", 
  "Id": "id:8-07A6kHAoIAAAAAAAABcg", "ClientModified": "2024-07-09T09:52:41Z", 
  "ServerModified": "2024-07-09T09:52:41Z", "Revision": "61ccd7da2b987c0f52053", "Size": "11", 
  "LowerCasePath": "/sahil kapoor/testingdropboxupdated/uploadfolderwithnestedfolder/nestedfolder2/license.txt",
   "DisplayPath": "/Sahil Kapoor/TestingDropBoxUpdated/uploadFolderWithNestedFolder/NestedFolder2/license.txt",
    "PreviewURL": null, "IsDownloadable": "true", "HasExplicitSharedMembers": null, 
  "ContentHash": "f6dc724d119649460e47ce719139e521e082be8a9755c5bece181de046ee65fe", "Owner": null,
  "Title": null, "MimeType": null, "FileData": "SGVsbG8gd29ybGQ=", "parent_shared_folder_id": "3237290067",
  "sharing_info_read_only": "false", "sharing_info_parent_shared_folder_id": "3237290067", 
  "sharing_info_modified_by": "dbid:AACVLctlrEo-ouTSxUVSTi0loZCSZKc933A" } ]

在集成中使用 Dropbox 连接

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

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

向 Google Cloud 社区寻求帮助

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

后续步骤

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