マーケット
完成したワークフローをテンプレートまたはモジュールとして公開し、バージョンごとに反復します。ダウンロード時に依存関係を自動解決し、インストール後すぐにインスタンス化して利用できます。
マーケットプレイスはコンソール内の「マーケットプレイス」ページです。コミュニティおよび公式が公開したテンプレートとモジュールがすべてここにあります。他人が公開した項目を自分のテンプレートライブラリやモジュールライブラリにダウンロードでき、自分で作成したワークフローを公開してバージョンごとにイテレーションすることもできます。テンプレートはダウンロード後に自分のワークフローとしてインスタンス化されます。モジュールはダウンロード後、直接 sub_workflow ステップから参照できます。
閲覧とカテゴリ
一覧はタイプ(テンプレート / モジュール)、カテゴリ、タグでフィルタリングでき、名前、説明、タグで検索することもできます。上部には 3 つのビューがあります: すべて、自分がアップロードしたもの、自分がダウンロードしたもの。各カードには作者、最新バージョン番号、ダウンロード回数が表示されます。プラットフォーム標準の項目には「公式」マークが付きます。
- カテゴリのドロップダウンの選択肢は、現在公開中の項目の実際のカテゴリに由来し、固定のリストではありません。カテゴリとタグはあなたのインターフェース言語に従って表示されます。
- マーケットプレイスには、公開済みかつあなたに表示可能な項目のみが表示されます。公開者は項目を公開、チームメンバーのみ表示可能、または指定ユーザーのみ表示可能に設定できます。表示不可の項目はあなたの一覧には表示されません。
- ダウンロード済みの項目はカード上に直接「ダウンロード済み」と表示されます。新バージョンがある場合、ボタンは「更新」に変わります。
テンプレートまたはモジュールを公開する
公開の入口はワークフローエディター内にあります。ワークフローの所有者のみがそれをマーケットプレイスに公開できます。管理者もあなたに代わって初回バージョンを公開することはできません。
- タイプ: モジュール契約を持つワークフローは「モジュール」として公開でき、そうでない場合は「テンプレート」としてのみ公開できます。モジュール形式で公開したい場合は、まずエディターで「モジュールに昇格」して契約を保存します。
- タイトル(必須、最大 200 文字)、概要(最大 5000 文字)、カテゴリ、タグ(最大 20 個)、アイコン、バージョン番号、更新内容を入力する必要があります。
- バージョン番号は semver 形式が要求されます。例: 1.0.0 または 1.0.0-beta。
- 表示範囲は 3 段階です: 全ユーザーに表示、自分が参加しているチームのメンバーのみ表示(チーム ID を入力)、指定ユーザーのみ表示(ユーザー ID を入力)。チームに表示を選択する場合、あなたは列挙した各チームのメンバーである必要があります。
- 価格: 現在は無料公開(0 USD)のみに対応しており、有料機能はまだ開放されていません。
- シリアライズ後のワークフロー定義は上限 2MB で、超過すると拒否されます。
curl -X POST https://braidrun.com/api/marketplace/items \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"sourceWorkflowId": "<workflow-id>",
"type": "TEMPLATE",
"title": "竞品价格日报",
"description": "每天拉取竞品价格并生成对比表",
"category": "数据分析",
"tags": ["监控", "报表"],
"version": "1.0.0",
"changelog": "首个版本",
"visibility": "PUBLIC",
"priceUsdCents": 0
}'アップロード後、項目は「承認待ち」状態になり、管理者の承認を経て初めて公開されます。公開済みの項目のみが他のユーザーのマーケットプレイス一覧に表示されます。却下された場合、「自分がアップロードしたもの」ビューで却下理由を確認できます。
バージョン管理
同一のワークフローを新しい項目として重複して公開することはできません。エディターは「このワークフローはすでに公開済みである」ことを自動的に認識し、ダイアログを「新バージョンをアップロード」に切り替えます。
- 項目の原作者のみが新バージョンを公開できます。プラットフォーム管理者は代理で公開できますが、項目の作者の帰属は変わりません。システム内蔵の項目は、管理者のみが新バージョンを公開できます。
- 新バージョン番号は正当な semver である必要があり、現在の最新バージョンを下回ることはできません。同一のバージョン番号を重複してアップロードすることはできません。
- 新バージョンも同様に承認待ちとなります。承認期間中、項目自体は公開されたままで、他のユーザーがダウンロードするのは引き続き最新の公開済みバージョンです。
- その項目をダウンロード済みのユーザーは、マーケットプレイスのカードと「自分がダウンロードしたもの」で更新の通知を確認でき、再ダウンロードすることで最新バージョンに更新できます。
- 項目の詳細ページには、完全なバージョン履歴と各バージョンの更新内容が一覧表示されます。
インストール: 依存関係の自動解決
「ダウンロード」をクリックすると、項目があなたのテンプレートライブラリまたはモジュールライブラリに保存されます。このテンプレートまたはモジュールが他のモジュール(sub_workflow ステップ)を参照している場合、ダウンロード前にプラットフォームが完全な依存関係グラフを解決し、各依存関係の状態を 1 つずつ表示します。
| ステータス | 意味 |
|---|---|
| ダウンロード済み | あなたのライブラリにそのモジュールの最新バージョンが既にあるため、スキップします |
| 更新する必要があります | 旧バージョンをダウンロード済みのため、今回まとめて最新バージョンに更新します |
| ダウンロード可 | マーケットプレイスにあり、まだダウンロードしていないため、今回まとめてダウンロードします |
| 不足 | マーケットプレイスに同名のモジュールが見つかりません |
| 非公開 | モジュールは存在しますが、あなたが含まれないチームまたはユーザーにのみ表示可能に限定されています |
「依存関係とともにダウンロード」を確認した後、インストールは依存関係の順序で進みます。まず最下層で参照されているモジュールをインストールし、層を上へたどり、最後にあなたがクリックした項目自体をインストールします。ダウンロード中、コピー内の sub_workflow が参照する workflow_id は、あなたのライブラリ内の対応するコピーの ID に自動的に書き換えられます。インストール完了後、参照を手動で変更する必要はなく、テンプレートは直接インスタンス化して実行でき、モジュールは直接参照できます。
# 下载最新版,连同依赖一起(返回本次创建的全部下载记录)
curl -X POST "https://braidrun.com/api/marketplace/items/<item-id>/download?withDependencies=true" \
-H "Authorization: Bearer <token>"
# 下载指定历史版本(只下载该条目本身,不做依赖级联)
curl -X POST "https://braidrun.com/api/marketplace/items/<item-id>/download?version=1.2.0" \
-H "Authorization: Bearer <token>"- 依存関係の解決は最新バージョンをダウンロードする場合にのみ行われます。過去のバージョンを指定してダウンロードする場合は、その項目自体のみがダウンロードされます。
- 循環参照(A が B を参照し、B がさらに A を参照する)は認識されて正常に処理され、インストールがフリーズすることはありません。
- ダウンロード自体はワークフローのクォータを消費せず、後のインスタンス化で初めて消費されます。
依存関係が「欠落」または「表示不可」と表示されている場合でも、親項目はライブラリにインストールできますが、対応する sub_workflow ステップは、そのモジュールが公開されるかあなたに表示可能になるまで実行できません。ダウンロード確認ダイアログには、これらの欠落が明確に一覧表示されます。
ダウンロード後: インスタンス化
ダウンロードは項目をあなたのライブラリに入れるだけで、コピーはデフォルトで読み取り専用にロックされます。実際に使い始めるには 2 つの経路があります。
- テンプレート: テンプレートライブラリでダウンロードした項目に対して「使用」をクリックすると、編集可能なワークフローがインスタンス化され、デフォルトで「元の名前 (テンプレートから作成)」と命名されます。このステップで初めてワークフロー数のクォータにカウントされます。
- モジュール: ダウンロード後、あなたのワークフローから sub_workflow ステップとして名前で参照できます。モジュールライブラリで編集可能なコピーをインスタンス化してから変更することもできます。
インスタンス化されたワークフローとマーケットプレイスの項目は互いに独立しています。作者が新バージョンを公開してもあなたのインスタンスは変更されません。「自分がダウンロードしたもの」である項目をアンインストールしても、既にインスタンス化したワークフローには影響しません。
ダウンロードしたライブラリのコピーはロック解除に対応しています。ロック解除後、エディターで直接編集できます。ただし注意点として、更新ダウンロードは新バージョンでこのライブラリのコピーを丸ごと置き換えるため、あなたの変更は失われます。長期的に変更したい場合は、自分のワークフローをインスタンス化してから変更してください。
よく使うエンドポイント
| Endpoint | 用途 |
|---|---|
GET /api/marketplace/items | 閲覧(ページネーション、タイプ / カテゴリ / タグ / 検索フィルタに対応) |
GET /api/marketplace/items/{id} | 項目の詳細 + バージョン履歴 |
GET /api/marketplace/categories | 現在表示可能な項目の全カテゴリ |
POST /api/marketplace/items | 新規項目の公開 |
POST /api/marketplace/items/{id}/versions | 新バージョンの公開 |
GET /api/marketplace/items/{id}/dependencies | 依存関係ツリーの表示 |
POST /api/marketplace/items/{id}/download | ダウンロード(最新バージョンのダウンロード時はデフォルトで依存関係も含む) |
GET /api/marketplace/my-uploads | 自分が公開した項目 |
GET /api/marketplace/my-downloads | 自分がダウンロードした項目(更新通知を含む) |
POST /api/marketplace/downloads/{itemId}/instantiate | ダウンロード済みの項目を編集可能なワークフローとしてインスタンス化する |
DELETE /api/marketplace/downloads/{itemId} | ダウンロード済みの項目をアンインストールする(インスタンス化済みのワークフローには影響しません) |