Storage

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

SaveFile

概要

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

パラメーター

*は、必須パラメーター

名前 概要
provider* 文字列 利用するコネクションのプロバイダID。デフォルトではAUTOROのストレージ(local)が使用されます。AUTOROのストレージの他に、Google Drive、Dropbox、box、OneDrive、AWS S3、Google Cloud Storage が利用できます。 local(default)
filename* 文字列、画像、ファイル 保存するファイル。ファイルはフルパスで指定されますが、指定できるのはワークフロー内でダウンロードしたものや作成したファイルのみです。 +get_file_1
directory 文字列 保存先のパス、もしくは保存先のフォルダID。未設定(空欄)の場合は、各クラウドサービスによって保存先が異なります。詳細は下記の「directoryパラメーターが未設定(空欄)の場合の保存先」の表をご覧ください。ルートディレクトリに保存したい場合は、/を指定します。一部のコネクションは共有フォルダへの保存に対応しております。詳細は下記の「共有フォルダを指定した場合の保存先」の説明をご覧ください。 /path/to/directory
createPath 真理値 trueの場合、保存先のフォルダを新たに作成します。 false(default)

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

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

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

プロバイダー directory パラメーター 保存先
Google Drive 共有ドライブ名:/path/to/content 指定した共有ドライブ内
OneDrive {ルートサイトURL}/sites/{サイト名}/Shared%20Documents/{フォルダ名}(ピッカーから選択できます)
または
サイト名:/path/to/content
チーム名:/path/to/content
Microsoft SharePoint サイト > ドキュメント内
Microsoft Teams チーム > ドキュメント内
Dropbox 共有フォルダ名/path/to/content
チームフォルダ名//path/to/content
チームフォルダ名//
指定した共有フォルダ内のフォルダ
指定したチームフォルダ内のフォルダ
指定したチームフォルダ直下
  • 共有フォルダへの保存は上記のコネクションに対応しております。
  • 現在、Dropbox のチームフォルダへの保存はピッカーには対応しておらず、フォルダの id で指定することもできません。directory パラメーターに直接、パスを指定して使用してください。
  • Dropbox のチームフォルダへのアクセスは SaveFile アクションでのみ可能です。その他のアクションではチームフォルダを対象とした操作をすることはできません。
  • OneDrive コネクションを使い、Microsoft Teams のチーム内にファイルを保存する場合は、チームのプライバシーを「パブリック」に設定してください。

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

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

使用不可文字について

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

アウトプット

タイプ 概要
Object オブジェクト ストレージ保存のレスポンス ※使用例のアウトプット参照

使用例

+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は、ファイルを取得するアクションです。

パラメーター

*は、必須パラメーター

名前 概要
provider* 文字列 利用するコネクションのプロバイダID。デフォルトではAUTOROのストレージ(local)が使用されます。 local
filename* 文字列、画像、ファイル 取得するファイルのID、もしくはパス IDでの指定: rc_33b74e85777203729f2d
パスでの指定: /path/to/file/image.jpg

filenameの指定方法

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

プロバイダー ID パス
AUTOROのストレージ ×
Google Drive
box
Dropbox
OneDrive
S3 ×
GCS ×

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

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

アウトプット

タイプ 概要
File ファイル 取得したファイルのローカルパス /tmp/02975d17-a685-4054-9859-d26a2baca435/gdrive_4d58af37ea2b6c4dfb8c/today_sakura

使用例

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

ListItems

概要

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

パラメーター

*は、必須パラメーター

名前 概要
provider* 文字列 利用するコネクションのプロバイダID。 gdrive_********************
directory* 文字列 ディレクトリのパス。ルートディレクトリを指定する場合は、/を入力します。 /path/to/directory
includeFileId 真偽値 true の時、アウトプットにファイルIDを含めます。現在、Google Drive、OneDriveのみ対応しています。 true
limit 数値 取得するアイテムの最大数 1000

アウトプット

タイプ 概要
List 配列 取得したアイテム includeFileId が false の時:['/path/to/directory/test.txt']
includeFileId が true の時:[ { id: 'FILE_ID_123', path: '/path/to/directory/test.txt' } ]

使用例

+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ファイルは元のページサイズのまま結合されます。

パラメーター

*は、必須パラメーター

名前 概要
files* 配列 対象ファイルのパス ["/dir/path/to/example1.pdf", "/dir/path/to/example2.pdf" ]

アウトプット

タイプ 概要
File ファイル PDFファイルのパス /dir/path/to/combined_20210828022851.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は、ファイルの名前を変更するアクションです。拡張子も変更しますのでご注意ください。

パラメーター

*は、必須パラメーター

名前 概要
filename* 文字列、画像、ファイル 対象ファイル。ファイルはフルパスで指定されますが、指定できるのはワークフロー内で取得したものや作成したファイルのみです。 +get_file_1
save_as* 文字列 新しいファイル名。拡張子も正しいものを入力してください。 新集計表.xlsx

アウトプット

タイプ 概要
File ファイル 名前を変更したファイル /tmp/b6b90347-f455-43ce-af42-f6ba8f17a920/local/新集計表.xlsx

使用例

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

パラメーター

*は、必須パラメーター

名前 概要
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>: CompressFile
  files: +create_list_1
  # => "/tmp/1322ce71-4c37-480a-bf23-9035a47be089/local/turn_pages.zip"

DecompressFile

概要

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

パラメーター

*は、必須パラメーター

名前 概要
file* 文字列 対象ファイルのパス "path/to/file.zip"
filename_encoding セレクト 圧縮されたファイルの文字コードを指定します。展開後のファイル名に日本語が含まれる場合は、文字化けする可能性があります。文字コードを指定することで文字化けを防ぐことができます。 Shift_JIS

アウトプット

タイプ 概要
Array 配列 展開したファイルのパス ['path/to/unzip.png', 'path/to/unzip.txt']

使用例

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

DeleteItem

概要

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

DeleteItem実行後の挙動一覧

プロバイダー 移動先
Onedrive, Dropbox, box ゴミ箱
AUTOROのストレージ, Google Drive, AWS S3, Google Cloud Storage 完全削除

パラメーター

*は、必須パラメーター

名前 概要
provider* 文字列 利用するコネクションのプロバイダID。デフォルトではAUTOROのストレージ(local)が使用されます。 local (default)
filename* 文字列、画像、ファイル、フォルダ 取得するファイルのID、もしくはパス IDでの指定: rc_33b74e85777203729f2d
パスでの指定: /path/to/file/image.jpg

filename の指定方法

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

プロバイダー ID パス
AUTOROのストレージ ×
Google Drive
box
Dropbox
OneDrive
S3 ×
GCS ×

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

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

アウトプット

タイプ 概要
Boolean 真偽値 エラーが起きない限り、完了後はtrueを返却 true

使用例

+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

パラメーター

*は、必須パラメーター

名前 概要
provider* 文字列 Google DriveのプロバイダID gdrive_**
filename* 文字列、画像、ファイル、フォルダ 取得するファイルのID、もしくはパス IDでの指定: hogehogehoge
パスでの指定: /path/to/file/hoge.jpg
directory* 文字列 新しい格納先のパス、もしくはフォルダID。ルートディレクトリに保存したい場合は、/を指定します。 /path/to/directory
createPath 真偽値 trueの場合、保存先のフォルダを新たに作成します。 false(default)
  • 各プロバイダごとにfilenameおよびdirectoryの指定方法が異なります。
    filenameは、GetFile記載の「filename の指定方法」を
    directoryは、SaveFile記載の「directory の指定方法」を参照ください。

アウトプット

タイプ 概要
Object オブジェクト エラーが起きない限り、完了後はファイル(もしくはフォルダ)のid, name, folder_idを返却 ※使用例のアウトプット参照

使用例

+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パラメータで指定したファイルを作成するディレクトリに移動させます。

パラメーター

*は、必須パラメーター

名前 概要
name* 文字列 ディレクトリ名 "new_directory"
files 配列 対象ファイルのパス ['path/file1.txt', 'path/file2.txt']

アウトプット

タイプ 概要
Directory 文字列 作成したディレクトリのパス "/tmp/c134789a-c03e-4542-9b76-9c1ce2c3be59/new_directory"

使用例

+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パラメータで指定したディレクトリに複製します。

パラメーター

*は、必須パラメーター

名前 概要
provider* 文字列 Google DriveのプロバイダID gdrive_**
filename* 文字列、画像、ファイル、フォルダ 取得するファイルのID、もしくはパス IDでの指定: rc_33b74e85777203729f2d
パスでの指定: /path/to/file/image.jpg
as 文字列 複製したファイル名。拡張子も正しいものを入力してください。複製先が複製元のファイルと同じフォルダ内の場合にasを指定しない時は「[複製元のファイル名] Copy」となります。 集計表.xlsx
directory 文字列 複製ファイルの格納先のパス、もしくはフォルダID。指定しない場合は複製元のファイルと同じフォルダ内に複製されます。 /path/to/directory
createPath 真偽値 trueの場合、保存先のフォルダを新たに作成します。 false(default)
  • 現在の対応プロバイダはGoogle Driveのみとなります。
  • 各プロバイダごとにfilenameの指定方法が異なります。
    filenameは、GetFile記載のfilenameの指定方法
    を参照ください。

アウトプット

タイプ 概要
Object オブジェクト エラーが起きない限り、完了後はファイル(もしくはフォルダ)のid, name, folder_idを返却 ※使用例のアウトプット参照

使用例

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

パラメーター

*は、必須パラメーター

名前 概要
provider* 文字列 利用するコネクションのプロバイダID。デフォルトではAUTOROのストレージ(local)が使用されます。 local
filename* 文字列 取得するファイルのID、もしくはパス IDでの指定: rc_33b74e85777203729f2d
パスでの指定: /path/to/file/image.jpg
type* 文字列 作成する共有リンクの種類。ファイルを閲覧できる「ブラウザ表示用リンク」(view) か、ファイルをダウンロードできる「ダウンロード用リンク」(download) かを指定してください。このパラメーターは各プロバイダーごとに対応状況や指定できる項目が異なるため以下のパラメーターに指定できるtypeをご参照ください。 view
expires_in 数値 共有リンクの有効期限。このパラメーターは各プロバイダーごとに対応状況や指定できる項目が異なるため以下のパラメーターに指定できるexpires_inをご参照ください。 0 (default)
role* 文字列 共有権限。共有リンクの参照者の権限を設定します。このパラメーターは各プロバイダーごとに対応状況や指定できる項目が異なるため以下のパラメーターに指定できるroleをご参照ください。 read
scope* 文字列 共有権限の範囲。共有対象のファイルへのアクセス権を設定します。このパラメーターは各プロバイダーごとに対応状況や指定できる項目が異なるため以下のパラメーターに指定できるscopeをご参照ください。 anyone
  • 各プロバイダごとにfilenameの指定方法が異なります。
    filenameは、GetFile記載のfilenameの指定方法
    を参照ください。

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

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

プロバイダー provider filename type expires_in role scope
AUTOROのストレージ × ×
Google Drive ×
Dropbox
OneDrive ×
S3 × × ×
GCS × ×

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

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

プロバイダー 「ブラウザ表示用リンク」(view) 「ダウンロード用リンク」(download)
AUTOROのストレージ
Google Drive
Dropbox
OneDrive ×
S3 ×
GCS

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

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

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

プロバイダー 指定できる有効期限 有効期限の最大値
AUTOROのストレージ 0 ~ 604800 604800秒 (7日間)
Google Drive 0
Dropbox 0 ~
OneDrive 0 ~ 63072000 63072000秒 (2年間)
S3 0 ~ 604800 604800秒 (7日間)
GCS 0 ~ 604800 604800秒 (7日間)

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

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

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

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

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

プロバイダー 「閲覧者」(read) 「閲覧者 (コメント可)」(comment) 「編集者」(write)
AUTOROのストレージ × ×
Google Drive
Dropbox ×
OneDrive ×
S3 × × x
GCS × ×

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

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

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

プロバイダー 「権限を新たに付与しない」(nothing) 「組織内のメンバーに権限を付与」(domain) 「リンクを知っている全員に権限を付与」(anyone)
AUTOROのストレージ × ×
Google Drive
Dropbox
OneDrive ×
S3 × ×
GCS × ×

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

アウトプット

タイプ 概要
File ファイル 共有リンクのパス ※使用例のアウトプット参照

使用例

+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"

results matching ""

    No results matching ""