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
(連接器 API)
如要瞭解如何啟用服務,請參閱「啟用服務」。
如果先前未為專案啟用這些服務或權限,系統會在設定連接器時提示您啟用。
設定連接器
連線是特定資料來源的連線,也就是說,如果您有多個資料來源,則必須為每個資料來源建立個別的連線。如要建立連線,請按照下列步驟操作:
- 在 Cloud 控制台中,前往「Integration Connectors」>「Connections」頁面,然後選取或建立 Google Cloud 專案。
- 按一下「+ 建立新連線」,開啟「建立連線」頁面。
- 在「位置」部分,選擇連線的位置。
- 區域:從下拉式清單中選取位置。
如需所有支援地區的清單,請參閱「位置」一節。
- 點按「下一步」。
- 區域:從下拉式清單中選取位置。
- 在「連線詳細資料」部分中,完成下列操作:
- 連接器:從可用連接器的下拉式清單中選取「Dropbox」。
- 連接器版本:從可用版本的下拉式清單中選取連接器版本。
- 在「Connection Name」欄位中,輸入連線例項的名稱。
連線名稱必須符合下列條件:
- 連線名稱可以包含英文字母、數字或連字號。
- 字母必須為小寫。
- 連線名稱的開頭必須是英文字母,結尾則須為英文字母或數字。
- 連結名稱不得超過 49 個半形字元。
- 視需要輸入連線例項的「Description」(說明)。
- 服務帳戶:選取具備必要角色的服務帳戶。
- 視需要設定連線節點設定:
- 節點數量下限:輸入連線節點數量下限。
- 節點數量上限:輸入連線節點數量上限。
節點是用來處理交易的連線單位 (或備用資源)。處理的交易量越多,就需要越多節點;反之,處理的交易量越少,就需要越少節點。如要瞭解節點對連接器定價的影響,請參閱「 連線節點的定價」。如果您未輸入任何值,系統預設會將最小節點設為 2 (以提高可用性),並將最大節點設為 50。
- 冒用 User-ID:可選,用於指定要冒用的 User-ID。
- 模擬使用者模式:可選,用於指定使用者模擬類型。應為使用者模式或管理員模式。
- Include Sub Directories:選用。如果您想在列出檔案和資料夾時納入子目錄,請勾選這個選項。
- Include Team Resources:選用。如果您想納入團隊檔案和資料夾,請勾選這個選項。
- 您可以按一下「+ 新增標籤」,以鍵/值組合的形式為連線新增標籤。
- 點按「Next」。
-
在「Authentication」部分中,輸入驗證詳細資料。
- 選取「驗證類型」並輸入相關詳細資料。
Dropbox 連線支援下列驗證類型:
- OAuth 2.0 驗證碼授權
- 點按「Next」。
如要瞭解如何設定這些驗證類型,請參閱「設定驗證」。
- 選取「驗證類型」並輸入相關詳細資料。
- 查看:查看連線和驗證詳細資料。
- 按一下 [建立]。
設定驗證機制
根據要使用的驗證方法輸入詳細資料。
-
OAuth 2.0 授權碼授權
- 用戶端 ID:用於要求存取權憑證的用戶端 ID。
- 範圍:以半形逗號分隔的 Dropbox 權限入口網站所需範圍清單。
- 用戶端密鑰:用於要求存取權存證的用戶端密鑰。
實體、作業和動作
所有整合連接器都為已連結應用程式的物件提供一層抽象層。您只能透過這個抽象層存取應用程式的物件。抽象概念會以實體、作業和動作的形式提供給您。
- 實體: 實體可視為已連結應用程式或服務中的物件或屬性集合。實體的定義與連接器至連接器的定義不同。舉例來說,在資料庫連接器中,資料表是實體;在檔案伺服器連接器中,資料夾是實體;在訊息系統連接器中,佇列是實體。
不過,連接器可能不支援或沒有任何實體,在這種情況下,
Entities
清單會是空白。 - 作業: 作業是指您可對實體執行的活動。您可以對實體執行下列任一操作:
從可用清單中選取實體後,系統會產生可用於該實體的作業清單。如需作業的詳細說明,請參閱連接器工作中的實體作業。不過,如果連接器不支援任何實體作業,則
Operations
清單中不會列出這些不支援的作業。 - 動作: 動作是透過連接器介面提供給整合項目的一流函式。動作可讓您變更實體或多個實體,而這些變更會因連接器而異。通常,動作會包含一些輸入參數和輸出參數。不過,連接器可能不支援任何動作,在這種情況下,
Actions
清單會為空白。
系統限制
Dropbox 連接器可處理每個節點每秒 18 筆交易,並限制超出此限制的任何交易。根據預設,Integration Connectors 會為連線分配 2 個節點 (可提高可用性)。
如要瞭解 Integration Connectors 適用的限制,請參閱「限制」一節。
動作
本節列出連接器支援的動作。如要瞭解如何設定動作,請參閱「動作範例」。
CopyResource 動作
這個動作可讓您將檔案或資料夾複製到使用者 Dropbox 中的其他位置。
CopyResource 動作的輸入參數
參數名稱 | 資料類型 | 必填 | 說明 |
---|---|---|---|
From_Path | 字串 | 是 | 使用者 Dropbox 中要複製或移動的路徑。 |
To_Path | 字串 | 是 | 使用者 Dropbox 中複製資源的目的路徑。 |
Autorename | 字串 | 否 | 如果發生衝突,請 Dropbox 伺服器嘗試自動重新命名檔案,以避免衝突。這個欄位的預設值為 False。 |
Allow_Ownership_Transfer | 字串 | 否 | 允許擁有者移動內容,即使這會導致內容擁有權轉移也一樣。但不適用於副本。這個欄位的預設值為 False。 |
ObjectPathsAggregate | 字串 | 否 | 代表物件路徑的集合。也可以是 #TEMP 資料表的名稱。 |
如需 CopyResource
動作的設定範例,請參閱「動作範例」。
CreateFolder 動作
這項動作可讓您在指定路徑中建立資料夾。
CreateFolder 動作的輸入參數
參數名稱 | 資料類型 | 必填 | 說明 |
---|---|---|---|
路徑 | 字串 | 是 | 要建立的使用者 Dropbox 路徑。 |
AutoRename | 布林值 | 否 | 如果發生衝突,請 Dropbox 伺服器嘗試自動重新命名資料夾,以免發生衝突。 預設值為 false。 |
ForceAsync | 布林值 | 否 | 是否要強制以非同步方式建立。僅適用於使用 ObjectPathsAggregate 時。預設值為 false。 |
ObjectPathsAggregate | 字串 | 否 | 代表路徑的 JSON 匯總。也可以是 #TEMP 資料表的名稱。 |
如需 CreateFolder
動作的設定範例,請參閱「動作範例」。
DeleteResource 動作
這項操作可讓您刪除指定路徑中的檔案或資料夾。如果路徑是資料夾,系統也會一併刪除資料夾中的所有內容。
DeleteResource 動作的輸入參數
參數名稱 | 資料類型 | 必填 | 說明 |
---|---|---|---|
路徑 | 字串 | 是 | 檔案或資料夾的專屬 ID。 |
ObjectPathsAggregate | 字串 | 否 | 代表物件路徑的集合。也可以是 #TEMP 資料表的名稱。 |
如需 DeleteResource
動作的設定範例,請參閱「動作範例」。
MoveResource 動作
將檔案或資料夾移至使用者 Dropbox 中的其他位置。如果來源路徑是資料夾,系統會移動該資料夾的所有內容。請注意,我們目前不支援僅變更大小寫的重新命名作業。
MoveResource 動作的輸入參數
參數名稱 | 資料類型 | 必填 | 說明 |
---|---|---|---|
From_Path | 字串 | 是 | 使用者 Dropbox 中要複製或移動的路徑。 |
To_Path | 字串 | 是 | 使用者 Dropbox 中的路徑,也就是目的地。 |
Autorename | 字串 | 否 | 如果發生衝突,請 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
動作的設定範例,請參閱「動作範例」。
行動號召範例
本節說明如何在這個連接器中執行部分動作。
範例:複製資源
以下範例說明如何將具有指定路徑的資源複製到其他路徑:
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
CopyResource
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
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" } ]
範例:建立資料夾
以下範例說明如何在指定路徑中建立資料夾:
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
CreateFolder
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "Path": "/TestDrobBoxFolder/newFolder" }
如果動作成功,CreateFolder
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[ { "Id": "id:8-07A6kHAoIAAAAAAAAC2Q" } ]
範例:刪除資源
以下範例說明如何刪除資源:
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
DeleteResource
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "Path": "/TestingDropBox/FolderToBeDeletedName" }
如果動作成功,DeleteResource
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Status": "Success" }]
範例:移動資源
以下範例說明如何移動資源:
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
MoveResource
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "From_Path": "/TestDropBoxFolder/Folder1/dummypdf2.pdf", "To_Path": "/EmptyFolder/Folder1/dummypdf2.pdf" }
如果動作成功,MoveResource
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Status": "Success" }]
範例:重新命名資源
以下範例說明如何重新命名資源:
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
RenameResource
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "Path": "/TestDropBox/abcd", "NewName": "abcded" }
如果動作成功,RenameResource
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Status": "Success" }]
範例:取消共用資料夾
以下範例說明如何取消共用資料夾:
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
UnshareFolder
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "FolderId": "3336772979" }
如果動作成功,UnshareFolder
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
[{ "Status": "Success" }]
範例:下載檔案
以下範例說明如何下載檔案:
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
DownloadFile
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
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 中建立及使用連接器工作,請參閱「連接器工作」。