クラウドBOT Docsトリガーとアクション
ホーム > 外部サービス連携 > Zapier > トリガーとアクション
- 1. トリガーとアクションの説明・使い方
- 2. Object定義
- 2.1. BOT Done Parameter Object (Data in)
- 2.2. Execute BOT Parameter Object (Data in)
- 2.3. Upload File Parameter Object (Data in)
- 2.4. Download File Parameter Object (Data in)
- 2.5. BOT Done Result Object (Data out)
- 2.6. Execute BOT Result Object (Data out)
- 2.7. Upload File Result Object (Data out)
- 2.8. Download File Result Object (Data out)
- 2.9. Output Object
- 2.10. Group Object
- 2.11. Meta Object
- 3. Dataの値について
トリガーとアクションの説明・使い方
| 種別 | トリガーまたはアクション名 | 説明 |
| トリガー | BOT Done | BOT実行完了をトリガーとして、フローを開始する事ができます。 BOTの出力値を取得し、以降のフローで利用できます。 |
| アクション | Execute BOT | クラウドBOT上のBOTをアクションとして実行する事ができます。 BOT実行時の入力値を指定できます。また、BOT完了時の出力値を以降のフローで利用できます。 |
| アクション | Upload File | ファイルデータをクラウドBOTへアップロードします。 File ref値が出力値として取得でき、その出力値はExcute BOTで使うことができます。 |
| アクション | Download File | クラウドBOTからファイルデータをダウンロードします。 File ref値からファイルを取り出すことができます。 |
BOT Done (トリガー)
BOT実行完了をトリガーとして、フローを開始する事ができます。BOTの出力値を取得し、以降のフローで利用できます。
BOT Doneの設定値
| Language | BOT実行言語を選択します。 |
| Contract | クラウドBOTの契約を選択します。 クラウドBOTで外部連携が有効の契約を選択できます。 |
| BOT | トリガーをかけるBOTを選択します。 クラウドBOTで外部連携済みのBOTが選択できます。 |
BOT Done Parameter Object (Data in) についてはこちらをご覧ください。
BOT Doneの実行結果 (Data out)
BOT Doneの実行結果として、BOT Done Result Object (Data out)が出力されます。
詳細はBOT Done Result Object (Data out)を参照してください。
Execute BOT (アクション)
クラウドBOT上のBOTをアクションとして実行する事ができます。BOT実行時の入力値を指定できます。また、BOT完了時の出力値を以降のフローで利用できます。
Execute BOTの設定値
| Language | BOT実行言語を選択します。 |
| Contract | クラウドBOTの契約を選択します。 クラウドBOTで外部連携が有効の契約を選択できます。 |
| BOT | 実行するBOTを選択します。 クラウドBOTで外部連携済みのBOTが選択できます。 |
| BOT入力値 | BOTの入力値を設定します。* 未設定の場合、BOTのデフォルト値で実行されます。 *フィールドには任意の入力値を設定することができます。テキストフォーマットはこちらを参照をしてください。 |
| Async | [False]BOTを非同期で実行します。BOTの実行開始をもって即時レスポンスを返します。 [True]BOTを同期で実行します。BOT実行完了時にレスポンスを返します。 *BOTを非同期で実行、またはBOT実行開始から25秒を超える場合は、BOTが実行中であってもその時点でレスポンスを返します。statusは"2"(実行中)になります。また、Cast URLが発行されます。 |
Execute BOT Parameter Object (Data in) についてはこちらをご覧ください。
Execute BOTの実行結果(Data out)
Execute BOTの実行結果として、 Execute BOT Result Object (Data out)が出力されます。
詳細はExecute BOT Result Object (Data out)を参照してください。
Upload File (アクション)
ファイルデータをクラウドBOTへアップロードします。File ref値が出力値として取得でき、その出力値はExcute BOTで使うことができます。
Upload Fileの設定値
| Language | BOT実行言語を選択します。 |
| Contract | クラウドBOTの契約を選択します。 クラウドBOTで外部連携が有効の契約を選択できます。 |
| File name | ファイルの名前を指定します。 前にあるトリガーやアクションの出力値から関連付けます。 |
| File | ファイル（hydrate形式またはURL形式）を指定します。 前にあるトリガーやアクションの出力値からファイルを関連付けます。 |
Upload File Parameter Object (Data in) についてはこちらをご覧ください。
Upload Fileの実行結果(Data out)
Upload Fileの実行結果として、 Upload File Result Object (Data out)が出力されます。
詳細はUpload File Result Object (Data out)を参照してください。
Download File (アクション)
クラウドBOTからファイルデータをダウンロードします。File ref値からファイルを取り出すことができます。
Download Fileの設定値
| Language | BOT実行言語を選択します。 |
| Contract | クラウドBOTの契約を選択します。 クラウドBOTで外部連携が有効の契約を選択できます。 |
| Ref | File ref値を指定します。 |
Download File Parameter Object (Data in) についてはこちらをご覧ください。
Download Fileの実行結果 (Data out)
Download Fileの実行結果として、 Download File Result Object (Data out)が出力されます。
詳細はDownload File Result Object (Data out)を参照してください。
Object定義
BOT Done Parameter Object (Data in)
BOT Doneの設定値を格納するObjectです。構造は以下の通りです。
| キー名 | 型 | 値 |
| lang | string | リクエスト言語 (日本語:ja 英語:en) |
| public_path | string | APIの公開パス |
| bot_id | string | BOT ID |
Execute BOT Parameter Object (Data in)
Execute BOTの設定値を格納するObjectです。構造は以下の通りです。
| キー名 | 型 | 値 |
| async | boolean | 同期モード (ture:同期 false:非同期) |
| lang | string | リクエスト言語 (日本語:ja 英語:en） |
| public_path | string | APIの公開パス |
| bot_id | string | BOT ID |
| {データ名}または{グループデータ名} | データ名…string / グループデータ名…list(array) of string | BOT入力値 |
Upload File Parameter Object (Data in)
Upload Fileの設定値を格納するObjectです。構造は以下の通りです。
| キー名 | 型 | 値 |
| lang | string | リクエスト言語 (日本語:ja 英語:en) |
| public_path | string | APIの公開パス |
| filename | string | ファイル名 |
| file | string | hydrate形式またはURL形式のテキスト |
Download File Parameter Object (Data in)
Download Fileの設定値を格納するObjectです。構造は以下の通りです。
| キー名 | 型 | 値 |
| lang | string | リクエスト言語 (日本語:ja 英語:en) |
| public_path | string | APIの公開パス |
| ref | string | File ref値 |
BOT Done Result Object (Data out)
BOT Doneの実行結果を格納するObjectです。構造は以下の通りです。
| キー名 | 型 | 値 |
| code | integer | レスポンスコード |
| job_id | string | ジョブID |
| bot_id | string | BOT ID |
| bot_name | string | BOT名 |
| start_time | string | 実行を開始した日時 (日付と時刻表記に関するISO8601に準ずる表記) |
| elapsed_time | string | 実行に要した秒数 |
| output | object | Output Object (BOTの出力データ値) |
Execute BOT Result Object (Data out)
Execute BOTの実行結果を格納するObjectです。構造は以下の通りです。
| キー名 | 型 | 値 |
| code | integer | レスポンスコード |
| job_id | string | ジョブID |
| bot_id | string | BOT ID |
| bot_name | string | BOT名 |
| status | integer | 実行ステータス (0:正常終了 1:エラー 2:実行中) |
| start_time | string | 実行を開始した日時 (日付と時刻表記に関するISO8601に準ずる表記) |
| cast_url * | string | BOT実行中の仮想ブラウザ画面を参照するURL |
| message | string | アナウンスメッセージ |
| output | object | Output Object (BOTの出力データ値) |
* Statusが2の場合、表示されます。
Upload File Result Object (Data out)
Upload Fileの実行結果を格納するObjectです。構造は以下の通りです。
| キー名 | 型 | 値 |
| ref | string | ファイルのref値 |
Download File Result Object (Data out)
Download Fileの実行結果を格納するObjectです。構造は以下の通りです。
| キー名 | 型 | 値 |
| download_url | string | ダウンロードURL |
| meta | object | Meta Object |
| file | string | ファイル (hydrate形式) |
Output Object
実行結果 (Data out)の出力値を格納するObjectです。データ、グループではそれぞれ値が異なります。構造は以下の通りです。
| キー名 | 型 | 値 |
| {データ名}または{グループ名} | データ名…string / グループ名…object | データ名…出力データ値 / グループ名…Group Object |
* データのテキストフォーマットについてはこちらをご覧ください。
Group Object
グループを格納するObjectです。構造は以下の通りです。
| キー名 | 型 | 値 |
| {グループデータ名} | list(array) of string | listの配列 |
* データのテキストフォーマットについてはこちらをご覧ください。
Meta Object
ファイルのメタデータを格納するObjectです。構造は以下の通りです。
| キー名 | 型 | 値 |
| filename | string | ファイル名 |
| size | integer | ファイルサイズ(byte) |
Dataの値について
テキストフォーマットについて
クラウドBOTの値に設定されているデータタイプごとによってテキストフォーマットが決まっています。
* パイプの前後にスペースが含まれる場合、それらのスペースを文字列として処理します。
| データタイプ | テキストフォーマット | 例 |
| テキストタイプ | 通常のテキストで表現します。 | プレーンワッフル |
| 複数テキストタイプ | パイプ区切りで表現します。 | 割引商品|ワッフル|焼き菓子 |
| ファイルタイプ | ファイルのRef値を表現します。 (ファイルが複数存在する場合は、パイプ区切りで表現します。) | jobs/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/files/… |
