# 共通フィールドとワークフロー構造

`GET /node-types?q=keyword&page=1&pageSize=20` で検索し、返されたタイプ ID を `GET /node-types/{nodeType}` に渡します。ページ番号は 1 から始まり、ページサイズは 1～100（既定値は 20）です。`browser_gotoUrl` のようなタイプは、`visit` のようなワークフロー内のノード ID とは別のものです。

| 契約のフィールド | 確認する内容 |
|  --- | --- |
| `authorable`、`runtimeSupported`、`externalRunnable`、`documentationComplete` | 作成できるか、ランタイムでサポートされているか、外部から実行できるか、ドキュメントが網羅されているかを確認します。 |
| `inputSchema` | 型、列挙値、形式、構造を確認します。`$ref` は、インスタンスのスキーマ URL を使って解決します。 |
| `conditionalRules`、`referenceRules` | モードごとに必須または禁止となるフィールド、解決後の値、許可される参照範囲を確認します。 |
| `defaults`、`outputVariants`、`fieldPolicies` | 実行時の既定値、モードごとの出力、フィールドポリシーを確認します。`x-editor-default` はエディターの初期値を表します。 |


## ワークフロー構造

`editorVersion: 2` と `editorParametersVersion: 1` を指定します。ルートの `nodes` は順番に実行され、先頭に 1 つの `start`、末尾に 1 つの `end` を置きます。入れ子になったノードには、各契約で指定された `blocks` を使用します。ノード ID はツリー全体で一意にし、編集しても変わらないように維持してください。すべてのノードと分岐に、内容がわかる `data.title` を付けます。グループの中に別のグループを含めることはできません。

アクションでは、`type: browser_<action>`、それに対応する `data.browserAction`、`data.browserUi.inputs` の下に置いた入力を使用します。アクションの入力には、`${targetUrl}` や `${visit.data.finalUrl}` のような文字列を使用します。終了ノードの出力と条件のオペランドには、パスセグメントの配列を使った `{"type":"ref","content":["visit","data","finalUrl"]}` を使用できます。参照するのは、可視範囲にある変数とそれより前のノードだけにしてください。カスタム変数は `start.data.customVariables` で宣言し、`browser_updateCustomVariable` で更新して、`${custom.<id>}` として読み取ります。保存後は、サーバーが正規化したツリーを使用してください。

## 変数参照

フィールドが変数参照をサポートしている場合は、`${…}` を使用し、省略記号の部分を実際の変数名または参照パスに置き換えます。ワークフローは実行時にその参照を解決し、得られた値をフィールドのルールに照らして検証します。

たとえば、`"selectorRadio": "${locatorType}"` は初期パラメーター `locatorType` を読み取ります。値が `"XPath"` の場合は XPath モードが選択されます。解決後の値は `"CSS"` または `"XPath"` でなければならないため、`"TEXT"` は検証に失敗します。

## フィールドの例と値の範囲

| フィールド | ルール |
|  --- | --- |
| `gotoUrl.url` | 必須の文字列で、参照をサポートします。移植可能なテンプレートでは、絶対 HTTP(S) URL を使用します。ほかのスキームを使う場合は、お使いのクライアントで事前検証し、ブラウザがそのスキームをどのように処理するかを確認してください。 |
| `gotoUrl.postWaitMs` | 数値、またはサポートされている数値式です。ドキュメントに記載された範囲は、解決後の値で 0～2147483647 ミリ秒です。既定値は 1000 で、待機しない場合は 0 を設定します。値はこの範囲内に収めてください。 |
| `getUrl.type` / `key` | `href`（既定値）、`origin`、`search` のいずれかです。search モードでは、空でない文字列に解決されるキーが必要です。href モードでは、`data.value` は現在の完全な URL です。search の値が存在しない場合の扱いは、実際の契約で確認してください。 |
| `browserUi.exception.timeout` | 0～2147483647 ミリ秒の整数です。0 を指定するとノードのタイムアウトは無効になりますが、実行全体の時間予算は引き続き適用されます。既定値は、アクションでは 30000、制御ノードでは 0 です。制御ノードに明示的に設定したタイムアウトは、その子グラフ全体に適用されます。 |
| `browserUi.exception.policy` | `interrupt`、`skip`、`handle` のいずれかを明示的に設定します。失敗したノードがスキップされた場合、そのデータへの参照は null に解決されます。実行の `hasNodeErrors` を確認してください。 |
| `retryTimes` / `retryInterval` | アトミックなアクションで再試行を有効にした場合、追加の試行回数は 1～10 回です。間隔は 0～2147483 **秒**です。再試行によって、すでに反映されたアクションが繰り返されることがあります。 |


テンプレートには、`title`（前後の空白を除いて 1～100 文字）、`description`（最大 1000 文字、空でも可）、`workflow`、`dependencies`（子テンプレートがない場合は `[]`）が必要です。リクエストとワークフローのサイズ、ノード数、ネストの深さ、1 回のリクエストあたりの編集数は、`capabilities.data.limits` で確認してください。完全なモデルについては、[ワークフロー、変数、構造ノード](/ja/browser-rpa/api/workflow)と[データモデル](/ja/browser-rpa/api/data-types)を参照してください。

次は、[例を検証して保存](/ja/browser-rpa/quickstart)します。