Storage

ファイルをクラウドサービスに保存したり、クラウドサービスから取得したりするアクションの一覧です。

SaveFile

概要

SaveFileは、クラウドサービスにファイルを保存するアクションです。directoryパラメータを設定することで、保存先のフォルダを指定できます。directoryパラメータで指定した保存先フォルダが見つからない場合は、エラーになります。 createPathパラメータをtrueにすることで保存先のフォルダを新たに作成できます。 directoryパラメータが未設定（空欄）の場合は、各クラウドサービスによって保存先が異なります。

パラメーター

*は、必須パラメーター

directoryパラメーターが未設定（空欄）の場合の保存先

• Google Drive、Dropbox、box、OneDrive の場合、「AUTORO/YYYY-MM-DD」フォルダに保存されます。YYYY-MM-DDには、今日の日付が入ります。
• AWS S3、Google Cloud Storage の場合、ルートディレクトリに保存されます。

共有フォルダを指定した場合の保存先

• 共有フォルダへの保存は上記のコネクションに対応しております。
• 現在、Dropbox のチームフォルダへの保存はピッカーには対応しておらず、フォルダの id で指定することもできません。directory パラメーターに直接、パスを指定して使用してください。
• Dropbox のチームフォルダへのアクセスは SaveFile アクションでのみ可能です。その他のアクションではチームフォルダを対象とした操作をすることはできません。
• OneDrive コネクションを使い、Microsoft Teams のチーム内にファイルを保存する場合は、チームのプライバシーを「パブリック」に設定してください。

各クラウドサービスのアクセス権限について

• Google Driveの共有ドライブを保存先に指定する場合や、共有ドライブに新しくパスを作成して保存する場合は、いずれの場合もユーザーのアクセス権限が「管理者」「コンテンツ管理者」「投稿者」のどれかに該当する必要があります。詳しくは共有ドライブのアクセスレベル - Google Workspace 管理者ヘルプをご参照ください。
• boxのストレージを保存先に指定する場合、またはboxのストレージに新しくパスを作成して保存する場合は、いずれの場合もboxユーザー権限が「共同所有者」「編集者」「ビューアー/アップローダー」「プレビューアー/アップローダー」のどれかに該当する必要があります。詳しくはコラボレータの権限レベルについて- boxをご参照ください。

使用不可文字について

• OneDriveで保存先のフォルダを新たに作成する場合、" * : < > ? / \ |　の文字は使用できません。

アウトプット

使用例

+save_file_1:
  action>: SaveFile
  provider: gdrive_********************
  filename: +get_file_1
  directory: '/path/to/directory' #共有ドライブの場合は 'ドライブ名:/path/to/directory'
  createPath: true
  # => {
  #   "file_id": "1Y2O5qBUBIPpiZfd9gW1UqehiZoXHBysJ",
  #   "filename": "photo-1552521923-b46b3137bab3",
  #   "folder_id": "1tefX_MX751GdbqOUroOjPtlALmsVSjg3"
  # }

GetFile

概要

GetFileは、ファイルを取得するアクションです。

パラメーター

*は、必須パラメーター

filenameの指定方法

filename の指定方法は、各プロバイダーによって異なります。以下の一覧表をご参照ください。

◎...ビジュアルモードで画面上からIDを取得可能、○...指定可能、×...指定不可

• Google Drive の共有ドライブから「パス指定」でファイルを取得する場合、共有ドライブ名:/path/to/fileのように指定します。ドライブ名の直後に:を入れ、それ以降はパスを指定します。
• 現在、Dropbox は共有フォルダ内のファイル取得は対応していますが、チームフォルダ内のファイル取得には対応していません。

アウトプット

使用例

+get_file_1:
  action>: GetFile
  provider: gdrive_********************
  filename: '/spring/sakura/today_sakura'
  # => "/tmp/02975d17-a685-4054-9859-d26a2baca435/gdrive_4d58af37ea2b6c4dfb8c/today_sakura"

ListItems

概要

ListItemsは、ディレクトリ内のアイテム一覧を取得するアクションです。

パラメーター

*は、必須パラメーター

アウトプット

使用例

+list_items_1:
  action>: ListItems
  provider: gdrive_********************
  directory: '/path/to/directory'
  includeFileId: false
  limit: 1000
  # => ['/path/to/directory/test1.txt', '/path/to/directory/test2.txt']

CombinePDF

概要

CombinePDFは、複数のPDFファイルを結合して一つのPDFファイルにまとめるアクションです。 結合されたPDFファイルのページ順は、filesパラメーターに設定されたPDFファイルの順番と同じになります。 PDFファイルは元のページサイズのまま結合されます。

パラメーター

*は、必須パラメーター

アウトプット

使用例

+combine_p_d_f_1:
  action>: CombinePDF
  files: ["/dir/path/to/example1.pdf", "/dir/path/to/example2.pdf" ]
  # => "/dir/path/to/combined_20210828022851.pdf"

RenameFile

概要

RenameFileは、ファイルの名前を変更するアクションです。拡張子も変更しますのでご注意ください。

パラメーター

*は、必須パラメーター

アウトプット

使用例

+rename_file_1:
  action>: RenameFile
  filename: +get_file_1
  save_as: '新集計表.xlsx'
  # => "/tmp/b6b90347-f455-43ce-af42-f6ba8f17a920/local/新集計表.xlsx"

CompressFile

概要

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 が置かれます。

また、passwordパラメーターを入力することで、作成するZipファイルにパスワードを設定することができます。パスワードには64文字以内の半角英数字記号を使用することができます。パスワードを設定する際には、encryptionMethodパラメーターで暗号化方式を指定してください。高い暗号強度のaes256 (AES-256)と、幅広いOSでサポートされているzip20 (Standard ZIP 2.0)から選択することができます。デフォルトはaes256です。

パラメーター

*は、必須パラメーター

アウトプット

使用例

+compress_file_1:
  action>: CompressFile
  files: +create_list_1
  # => "/tmp/1322ce71-4c37-480a-bf23-9035a47be089/local/turn_pages.zip"

DecompressFile

概要

圧縮されたファイルを展開し、 展開したファイルのパスをリストとして出力します。現在対応している圧縮形式はzipのみです。

パラメーター

*は、必須パラメーター

アウトプット

使用例

+decompress_file_1:
  action>: DecompressFile
  file: 'path/to/file.zip'
  filename_encoding: Shift_JIS
  password: 6w3zmoLk
  # => ['path/to/unzip.png', 'path/to/unzip.txt']

DeleteItem

概要

DeleteItemは、ファイルまたはフォルダを削除するアクションです。ファイルがゴミ箱へ移動するか、完全に削除されるかは各プロバイダーによって異なります。

DeleteItem実行後の挙動一覧

パラメーター

*は、必須パラメーター

filename の指定方法

filename の指定方法は、各プロバイダーによって異なります。以下の一覧表をご参照ください。

◎...ビジュアルモードで画面上からIDを取得可能、○...指定可能、×...指定不可

• Google Drive の共有ドライブにあるファイルまたはフォルダを「パス指定」で削除する場合、共有ドライブ名:/path/to/contentのように指定します。ドライブ名の直後に:を入れ、それ以降はパスを指定します。

アウトプット

使用例

+delete_file_1:
  action>: DeleteItem
  provider: gdrive_********************
  filename: '/spring/sakura/today_sakura.jpg'
  # => "true"

MoveItem

概要

MoveItemは、ファイルの格納フォルダを変更するアクションです。対応しているプロバイダは下記の通りです。
Google Drive, Dropbox, box, OneDrive, AWS S3, Google Cloud Storage

パラメーター

*は、必須パラメーター

• 各プロバイダごとにfilenameおよびdirectoryの指定方法が異なります。
  filenameは、GetFile記載の「filename の指定方法」を
  directoryは、SaveFile記載の「directory の指定方法」を参照ください。

アウトプット

使用例

+move_item_1:
  action>: MoveItem
  provider: gdrive_********************
  filename: '/sample/hogehogehoge.png'
  directory: '/path/to/directory' #共有ドライブの場合は 'ドライブ名:/path/to/directory'
  createPath: true
  # => {
  #   "id": "1Y2O5qBUBIPpiZfd9gW1UqehiZoXHBysJ",
  #   "name": "hogehogehoge.png"
  #   "folder_id": "17eI94QVrT9N8diaoZmicV1szlIJ8dozd"
  # }

MakeDirectory

概要

MakeDirectoryは、新しいディレクトリを作成するアクションです。filesパラメータで指定したファイルを作成するディレクトリに移動させます。

パラメーター

*は、必須パラメーター

アウトプット

使用例

+make_directory_1:
  action>: MakeDirectory
  name: new_directory
  files: ['path/file1.txt', 'path/file2.txt']
  # => "/tmp/c134789a-c03e-4542-9b76-9c1ce2c3be59/new_directory"

CopyFile

概要

CopyFileは、ファイルを複製するアクションです。filesパラメータで指定したファイルを、asパラメータで指定した名称で、directoryパラメータで指定したディレクトリに複製します。

パラメーター

*は、必須パラメーター

• 現在の対応プロバイダはGoogle Driveのみとなります。
• 各プロバイダごとにfilenameの指定方法が異なります。
  filenameは、GetFile記載のfilenameの指定方法を
  を参照ください。

アウトプット

使用例

+copy_file_1:
  provider: gdrive_********************
  filename: '/sample/hoge.png'
  as: 'hogehogehoge.png'
  directory: '/path/to/directory' #共有ドライブの場合は 'ドライブ名:/path/to/directory'
  createPath: true
  # => {
  #   "id": "1Y2O5qBUBIPpiZfd9gW1UqehiZoXHBysJ",
  #   "name": "hogehogehoge.png"
  #   "folder_id": "17eI94QVrT9N8diaoZmicV1szlIJ8dozd"
  # }

GetShareLink

概要

GetShareLinkは、クラウドサービスに保存してあるファイルに対する共有リンクを取得するアクションです。対応しているプロバイダは下記の通りです。
AUTOROのストレージ, Google Drive, OneDrive、Dropbox、AWS S3、Google Cloud Storage(GCS)

パラメーター

*は、必須パラメーター

• 各プロバイダごとにfilenameの指定方法が異なります。
  filenameは、GetFile記載のfilenameの指定方法を
  を参照ください。

プロバイダーのパラメーター対応表

パラメーターに指定できる項目は、各プロバイダーによって対応状況が異なります。以下の一覧表をご参照ください。

○...指定可能、×...指定不可(設定は実行結果に影響しない)

パラメーターに指定できるtype

※ OneDrive、S3では「ブラウザ表示用リンク」(view)のみ対応のため、この設定は実行結果に影響しません。

※ Google Drive でダウンロード用リンクが生成できるのはGoogleスプレッドシート、Googleドキュメント、Google図形描画、Googleスライドです。

パラメーターに指定できるexpires_in

※ 最大値より大きい値が指定された場合、最大値が設定されます。

※ プロバイダが Google Drive の場合、無期限のみ対応のため、この設定は結果に影響しません。

※ AUTOROのストレージ、S3、GCS で 0 を設定した場合、期限は最大値の604800秒 (7日間)になります。

※ OneDrive、Dropbox で 0 を設定した場合、期限は無期限になります。また、OneDrive、Dropbox のプランによっては無期限しか設定できません。

パラメーターに指定できるrole

※ AUTOROのストレージ、GCS、S3では「閲覧者」(read)のみ対応のため、この設定は実行結果に影響しません。

※ リンクを設定するファイルの種類によっては、「編集者」(write)を付与できない場合があります。

パラメーターに指定できるscope

※ AUTOROのストレージ、GCS、S3では「リンクを知っている全員に権限を付与」(anyone)のみ対応のため、この設定は実行結果に影響しません。

アウトプット

使用例

+get_share_link_1:
  action>: GetShareLink
  provider: local
  filename: rc_xxxxxxxxxxxxxxxxxxxx
  type: view
  expires_in: 1800
# => "https://storage.googleapis.com/sample/sample?GoogleAccessId=xxxxxxxx.iam.gserviceaccount.com&Signature=xxxxxxxx&Expires=xxxxxxxx"

+get_share_link_1:
  action>: GetShareLink
  provider: gdrive_xxxxxxxxxxxxxxxxxxxx
  filename: 'dummy-file-name'
  type: view
  role: read
  scope: nothing
# => https://drive.google.com/file/d/dummy-file-name/view?usp=drivesdk

+get_share_link_1:
  action>: GetShareLink
  provider: onedrive_xxxxxxxxxxxxxxxxxxxx
  filename: '11111111111111111111'
  expires_in: 0
  role: write
  scope: anyone
# => https://1drv.ms/t/s!xxxxxxxxxxxxxxxxxxxxxxxxxxxx

+get_share_link_1:
  action>: GetShareLink
  provider: dbx_xxxxxxxxxxxxxxxxxxxx
  filename: 'id:XXXXXXXXX'
  type: view
  expires_in: 1800
  role: comment
  scope: anyone
# => https://www.dropbox.com/s/lfcaai41vzdummy/sample.jpeg?dl=0

+get_share_link_1:
  action>: GetShareLink
  provider: s3_xxxxxxxxxxxxxxxxxxxx
  filename: '/test/dummy.png'
  expires_in: 1800
# => https://rctestlocal.s3.ap-northeast-1.amazonaws.com/rcdev/human.png?AWSAccessKeyId=xxxxxxxx&Expires=xxxxxxx

+get_share_link_1:
  action>: GetShareLink
  provider: gcs_xxxxxxxxxxxxxxxxxxxx
  filename: '/test/dummy.png'
  type: view
  expires_in: 1800
# => "https://storage.googleapis.com/test/test?GoogleAccessId=xxxxxxxx.iam.gserviceaccount.com&Signature=xxxxxxxx&Expires=xxxxxxxx"