Storage
ファイルをクラウドサービスに保存したり、クラウドサービスから取得したりします。
SaveFileは、クラウドサービスにファイルを保存するアクションです。directoryパラメータを設定することで、保存先のフォルダを指定できます。directoryパラメータで指定した保存先フォルダが見つからない場合は、エラーになります。 createPathパラメータをtrueにすることで保存先のフォルダを新たに作成できます。 directoryパラメータが未設定（空欄）の場合は、各クラウドサービスによって保存先が異なります。
*は、必須パラメーター
名前 | 型 | 概要 | 例 |
filename* | 文字列、画像、ファイル | 保存するファイル。ファイルはフルパスで指定されますが、指定できるのはワークフロー内でダウンロードしたものや作成したファイルのみです。 | +get_file_1 |
provider* | 文字列 | 利用するコネクションのプロバイダID。デフォルトではRobotic Crowdのストレージ(local)が使用されます。localの他に、Google Drive、Dropbox、box、OneDrive、AWS S3、Google Cloud Storage が利用できます。 | local(default) |
directory | 文字列 | 保存先のパス、もしくは保存先のフォルダID。未設定（空欄）の場合は、各クラウドサービスによって保存先が異なります。詳細は下記の表をご覧ください。ルートディレクトリに保存したい場合は、 | /path/to/directory |
createPath | 真理値 | trueの場合、保存先のフォルダを新たに作成します。 | false(default) |
Google Drive、Dropbox、box、OneDrive の場合、「RoboticCrowd/YYYY-MM-DD」フォルダに保存されます。YYYY-MM-DDには、今日の日付が入ります。
AWS S3、Google Cloud Storage の場合、ルートディレクトリに保存されます。
プロバイダー | 保存先 |
Google Drive | RoboticCrowd/YYYY-MM-DD |
Dropbox | RoboticCrowd/YYYY-MM-DD |
box | RoboticCrowd/YYYY-MM-DD |
OneDrive | RoboticCrowd/YYYY-MM-DD |
AWS S3 | ルートディレクトリ |
Google Cloud Storage | ルートディレクトリ |
Google Driveの共有ドライブを保存先に指定する場合や、共有ドライブに新しくパスを作成して保存する場合は、いずれの場合もユーザーのアクセス権限が「管理者」「コンテンツ管理者」「投稿者」のどれかに該当する必要があります。詳しくは共有ドライブのアクセスレベル - G Suite 管理者ヘルプをご参照ください。
boxのストレージを保存先に指定する場合、またはboxのストレージに新しくパスを作成して保存する場合は、いずれの場合もboxユーザー権限が「共同所有者」「編集者」「ビューアー/アップローダー」「プレビューアー/アップローダー」のどれかに該当する必要があります。詳しくはコラボレータの権限レベルについて- boxをご参照ください。
タイプ | 型 | 概要 | 例 |
Object | オブジェクト | ストレージ保存のレスポンス | ※使用例のアウトプット参照 |
+save_file_1:action>: SaveFilefilename: +get_file_1provider: gdrive_********************directory: '/path/to/directory' #共有ドライブの場合は 'ドライブ名:/path/to/directory'createPath: true# => {# "file_id": "1Y2O5qBUBIPpiZfd9gW1UqehiZoXHBysJ",# "filename": "photo-1552521923-b46b3137bab3"# }
GetFileは、ファイルを取得するアクションです。
*は、必須パラメーター
名前 | 型 | 概要 | 例 |
filename* | 文字列、画像、ファイル | 取得するファイルのID、もしくはパス | IDでの指定: rc_33b74e85777203729f2d パスでの指定: /path/to/file/image.jpg |
provider* | 文字列 | 利用するコネクションのプロバイダID | local (default) |
filename の指定方法は、各プロバイダーによって異なります。以下の一覧表をご参照ください。
プロバイダー | ID | パス |
local | ○ | × |
Google Drive | ◎ | ○ |
box | ◎ | ○ |
Dropbox | ◎ | ○ |
OneDrive | ◎ | ○ |
S3 | × | ○ |
GCS | × | ○ |
◎...ビジュアルモードで画面上からIDを取得可能、○...指定可能、×...指定不可
Google Drive の共有ドライブから「パス指定」でファイルを取得する場合、
共有ドライブ名:/path/to/fileのように指定します。ドライブ名の直後に:を入れ、それ以降はパスを指定します。
タイプ | 型 | 概要 | 例 |
File | ファイル | 取得したファイルのローカルパス | /tmp/02975d17-a685-4054-9859-d26a2baca435/gdrive_4d58af37ea2b6c4dfb8c/today_sakura |
+get_file_1:action>: GetFilefilename: '/spring/sakura/today_sakura'provider: gdrive_********************# => "/tmp/02975d17-a685-4054-9859-d26a2baca435/gdrive_4d58af37ea2b6c4dfb8c/today_sakura"
ListItemsは、ディレクトリ内のアイテム一覧を取得するアクションです。
*は、必須パラメーター
名前 | 型 | 概要 | 例 |
directory* | 文字列 | ディレクトリのパス。ルートディレクトリを指定する場合は、 | /path/to/directory |
provider* | 文字列 | 利用するコネクションのプロバイダID。 | gdrive_******************** |
limit | 数値 | 取得するアイテムの最大数 | 1000 |
タイプ | 型 | 概要 | 例 |
List | 配列 | 取得したアイテムのパス | ['/path/to/directory/test.txt'] |
+list_items_1:action>: ListItemsdirectory: '/path/to/directory'provider: gdrive_********************limit: 1000# => ['/path/to/directory/test1.txt', '/path/to/directory/test2.txt']
RenameFileは、ファイルの名前を変更するアクションです。拡張子も変更しますのでご注意ください。
*は、必須パラメーター
名前 | 型 | 概要 | 例 |
filename* | 文字列、画像、ファイル | 対象ファイル。ファイルはフルパスで指定されますが、指定できるのはワークフロー内で取得したものや作成したファイルのみです。 | +get_file_1 |
save_as* | 文字列 | 新しいファイル名。拡張子も正しいものを入力してください。 | 新集計表.xlsx |
タイプ | 型 | 概要 | 例 |
File | ファイル | 名前を変更したファイル | /tmp/b6b90347-f455-43ce-af42-f6ba8f17a920/local/新集計表.xlsx |
+rename_file_1:action>: RenameFilefilename: +get_file_1save_as: '新集計表.xlsx'# => "/tmp/b6b90347-f455-43ce-af42-f6ba8f17a920/local/新集計表.xlsx"
CompressFileは、ファイルをZipで圧縮するアクションです。filesパラメータで圧縮対象のファイルを配列で設定します。ファイルを複数設定した場合、アウトプットのファイルパスは、files[0]のディレクトリ名/archive.zipとなります。 ファイルではなくフォルダが指定されている場合は、フォルダごと圧縮します。 ファイルとフォルダをまとめて圧縮することも可能です。例えば、filesを["path/to/folder", "path/to/item1.txt", "path/to/item2.txt"]とした場合、path/to/archive.zipが作成され、その中に folder, item1.txt, item2.txt が置かれます。
*は、必須パラメーター
名前 | 型 | 概要 | 例 |
files* | 配列 | 対象ファイルのパス | ["/tmp/1322ce71-4c37-480a-bf23-9035a47be089/local/turn_pages.jpeg"] |
files* | 配列 | 対象フォルダのパス | ["/tmp/1322ce71-4c37-480a-bf23-9035a47be089/local/folder"] |
タイプ | 型 | 概要 | 例 |
File | ファイル | 圧縮したファイル | /tmp/1322ce71-4c37-480a-bf23-9035a47be089/local/turn_pages.zip |
File | ファイル | 圧縮したファイル | /tmp/1322ce71-4c37-480a-bf23-9035a47be089/local/folder.zip |
+compress_file_1:action>: CompressFilefiles: +create_list_1# => "/tmp/1322ce71-4c37-480a-bf23-9035a47be089/local/turn_pages.zip"
圧縮されたファイルを展開し、 展開したファイルのパスをリストとして出力します。現在対応している圧縮形式はzipのみです。
*は、必須パラメーター
名前 | 型 | 概要 | 例 |
file* | 文字列 | 対象ファイルのパス | "path/to/file.zip" |
タイプ | 型 | 概要 | 例 |
Array | 配列 | 展開したファイルのパス | ['path/to/unzip.png', 'path/to/unzip.txt'] |
+decompress_file_1:action>: DecompressFilefile: 'path/to/file.zip'# => ['path/to/unzip.png', 'path/to/unzip.txt']
DeleteItemは、ファイルまたはフォルダを削除するアクションです。ファイルがゴミ箱へ移動するか、完全に削除されるかは各プロバイダーによって異なります。
DeleteItem実行後の挙動一覧
プロバイダー | 移動先 |
Onedrive, Dropbox, box | ゴミ箱 |
local, Google Drive, AWS S3, Google Cloud Storage | 完全削除 |
*は、必須パラメーター
名前 | 型 | 概要 | 例 |
filename* | 文字列、画像、ファイル、フォルダ | 取得するファイルのID、もしくはパス | IDでの指定: rc_33b74e85777203729f2d パスでの指定: /path/to/file/image.jpg |
provider* | 文字列 | 利用するコネクションのプロバイダID | local (default) |
filename の指定方法は、各プロバイダーによって異なります。以下の一覧表をご参照ください。
プロバイダー | ID | パス |
local | ○ | × |
Google Drive | ◎ | ○ |
box | ◎ | ○ |
Dropbox | ◎ | ○ |
OneDrive | ◎ | ○ |
S3 | × | ○ |
GCS | × | ○ |
◎...ビジュアルモードで画面上からIDを取得可能、○...指定可能、×...指定不可
Google Drive の共有ドライブにあるファイルまたはフォルダを「パス指定」で削除する場合、
共有ドライブ名:/path/to/contentのように指定します。ドライブ名の直後に:を入れ、それ以降はパスを指定します。
タイプ | 型 | 概要 | 例 |
Boolean | 真偽値 | エラーが起きない限り、完了後はtrueを返却 | true |
+delete_file_1:action>: DeleteItemfilename: '/spring/sakura/today_sakura.jpg'provider: gdrive_********************# => "true"
MakeDirectoryは、新しいディレクトリを作成するアクションです。filesパラメータで指定したファイルを作成するディレクトリに移動させます。
*は、必須パラメーター
名前 | 型 | 概要 | 例 |
name* | 文字列 | ディレクトリ名 | "new_directory" |
files | 配列 | 対象ファイルのパス | ['path/file1.txt', 'path/file2.txt'] |
タイプ | 型 | 概要 | 例 |
Directory | 文字列 | 作成したディレクトリのパス | "/tmp/c134789a-c03e-4542-9b76-9c1ce2c3be59/new_directory" |
+make_directory_1:action>: MakeDirectoryname: new_directoryfiles: ['path/file1.txt', 'path/file2.txt']# => "/tmp/c134789a-c03e-4542-9b76-9c1ce2c3be59/new_directory"
