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）
  サービスを有効にする方法については、サービスを有効にするをご覧ください。
以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。

コネクタを構成する

コネクタを構成するには、データソース（バックエンドシステム）への接続を作成する必要があります。接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。

Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。
[接続] ページに移動
[+ 新規作成] をクリックして [接続の作成] ページを開きます。
[ロケーション] セクションで、接続のロケーションを選択します。
1. リージョン: プルダウンリストからロケーションを選択します
  サポートされているすべてのリージョンのリストについては、ロケーションをご覧ください。
2. [NEXT] をクリックします。
[接続の詳細] セクションで、次の操作を行います。
1. コネクタ: 使用可能なコネクタのプルダウンリストから [Dropbox ] を選択します。
2. Connector version: 使用可能なバージョンのプルダウンリストからコネクタのバージョンを選択します。
3. [接続名] フィールドに、接続インスタンスの名前を入力します。
  接続名は次の条件を満たす必要があります。
  - 接続名には英字、数字、ハイフンを使用できます。
  - 文字は小文字のみを使用できます。
  - 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
  - 接続名は 49 文字以内で指定してください。
4. 必要に応じて、接続インスタンスの [説明] を入力します。
5. サービスアカウント: 必要なロールを持つサービスアカウントを選択します。
6. 必要に応じて、接続ノードの設定を構成します。
  - ノードの最小数: 接続ノードの最小数を入力します。
  - ノードの最大数: 接続ノードの最大数を入力します。
  ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。
7. Impersonate User Id: 必要に応じて、権限を借用するユーザー ID を指定します。
8. なりすましユーザーモード:必要に応じて、ユーザーのなりすましのタイプを指定します。ユーザーモードか管理モードかを指定します。
9. サブディレクトリを含める: 省略可。ファイルとフォルダの一覧表示中にサブディレクトリを含める場合。
10. チームリソースを含める: チームのファイルとフォルダを含める場合は、このチェックボックスをオンにします。
11. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
12. [次へ] をクリックします。
[認証] セクションで、認証の詳細を入力します。
1. [認証タイプ] を選択し、関連する詳細を入力します。
  ドロップボックス接続でサポートされる認証タイプは次のとおりです。
  - OAuth 2.0 認証コードの付与
2. [次へ] をクリックします。
Review: 接続と認証の詳細を確認します。
[作成] をクリックします。

認証を構成する

使用する認証に基づいて詳細を入力します。

OAuth 2.0 認証コード付与
- クライアント ID: アクセストークンのリクエストに使用されるクライアント ID。
- スコープ: Dropbox 権限ポータルで必要なスコープのカンマ区切りのリスト。
- クライアントシークレット: アクセストークンのリクエストに使用されるクライアントシークレット。

エンティティ、オペレーション、アクション

すべての Integration Connectors が、接続されたアプリケーションのオブジェクトを抽象化するレイヤを提供します。アプリケーションのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化は、エンティティ、オペレーション、アクションとして公開されます。

エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベースコネクタでは、テーブルがエンティティであり、ファイルサーバーコネクタでは、フォルダがエンティティです。また、メッセージングシステムコネクタでは、キューがエンティティです。
ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、Entities リストは空になります。
オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。
- リスト
- 取得
- 作成
- 更新
- 削除
使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティオペレーションをご覧ください。ただし、コネクタがいずれかのエンティティオペレーションをサポートしていない場合、サポートされていないオペレーションは Operations リストに含まれません。
アクション: コネクタインターフェースを介して統合で使用できる主要な関数の一つです。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。通常、アクションには入力パラメータと出力パラメータがあります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。

システムの上限

Dropbox コネクタは、ノードごとに 1 秒あたり最大 18 件のトランザクションを処理することができ、この上限を超えるトランザクションはすべてスロットルされます。デフォルトでは、Integration Connectors は、接続に 2 つのノードを割り当てます（可用性を高めるため）。

Integration Connectors に適用される上限の詳細については、上限をご覧ください。

注: Integration Connectors ノードの数は、使用状況に応じて動的に自動スケーリングされます。ただし、自動スケーリングを待たずに大量の容量を確保する場合は、接続の最小ノード値を調整できます。1 つの接続により多くのトランザクションを処理するには、より多くのノードが必要です。逆に、接続が処理するトランザクションが少ない場合は、必要なノードの数が少なくなります。ノードの値を構成するには、次の手順を行います。

従量課金制をご利用のお客様は、接続の編集ページでノードの最小値と最大値を構成します。
サブスクリプションベースで利用されているお客様は、サポートにお問い合わせください。

ノードが処理できる最大トランザクションは、さまざまな要因によって異なります。そのため、スループットを高めるために最小ノードを調整する前に、バックエンドシステムが必要なトラフィックを処理するために最適に設定されているかどうかを確認することをおすすめします。

アクション

このセクションには、コネクタでサポートされているアクションが一覧表示されます。アクションの構成方法については、アクションの例をご覧ください。

注: すべてのアクションの結果は、統合を実行した後に Connectors タスクの connectorOutputPayload レスポンスパラメータで JSON レスポンスとして利用できます。

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 アクションの入力パラメータ

パラメータ名	データ型	必須	説明
パス	文字列	○	ファイルまたはフォルダの一意の識別子。
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 アクション

このアクションにより、フォルダの共有を停止できます。Share.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] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、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] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
  "Path": "/TestDrobBoxFolder/newFolder"
}
```

アクションが成功すると、CreateFolder タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

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

例 - リソースを削除する

次の例は、リソースを削除する方法を示しています。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[DeleteResource] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
  "Path": "/TestingDropBox/FolderToBeDeletedName"
}
```

アクションが成功すると、DeleteResource タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

[{
"Status": "Success"
}]

例 - リソースを移動する

次の例は、リソースを移動する方法を示しています。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[MoveResource] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
  "From_Path": "/TestDropBoxFolder/Folder1/dummypdf2.pdf",
  "To_Path": "/EmptyFolder/Folder1/dummypdf2.pdf"
}
```

アクションが成功すると、MoveResource タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

[{
  "Status": "Success"
  }]

例 - リソースの名前を変更する

次の例は、リソースの名前を変更する方法を示しています。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[RenameResource] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
  "Path": "/TestDropBox/abcd",
  "NewName": "abcded"
}
```

アクションが成功すると、RenameResource タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

[{
"Status": "Success"
}]

例 - フォルダの共有を停止する

次の例では、フォルダの共有を停止する方法を示します。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[UnshareFolder] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
  "FolderId": "3336772979"
}
```

アクションが成功すると、UnshareFolder タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

[{
"Status": "Success"
}]

例 - ファイルをダウンロードする

次の例は、ファイルをダウンロードする方法を示しています。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[DownloadFile] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、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 で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。

Google Cloud コミュニティの助けを借りる

Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。