メインコンテンツまでスキップ

KurocoEdge の変数の利用方法

概要

KurocoEdge では、ルールのアクション内で主に3つの異なる方法で変数を扱うことができます。

このドキュメントでは、それぞれの変数の種類の概要を説明し、基本的な使用方法とベストプラクティスを提供します。

各変数の種類は、ルール内の任意のアクションの「条件 / 変数」セクションで作成および管理することができます。

スタティック変数

スタティック変数は、アクションの「条件/変数」セクションで新しい「スタティック変数」を作成することで明示的に割り当てることができます。

これは、KurocoEdge で使用できる最も基本的な変数の形式です。

スタティック変数の利用目的

プログラミング言語と同様に、値を格納する変数を定義して後で簡単に呼び出すことは便利です(値を繰り返し入力する必要がないため)。

スタティック変数は、アクションの「実行」セクションのフィールドで使用でき、値を入力するためのよりクリーンで効率的な方法です。

備考

スタティック変数の作成と使用方法についてのチュートリアルは、以下のドキュメントを参照してください。

静的変数を使用する

キャプチャ変数

キャプチャ変数は、アクション内のルールの「条件/変数」セクションで明示的に定義される「スタティック」または「API」変数とは異なり、特別な「キャプチャ」変数を定義することもできます。このタイプの変数は、キャプチャされた「フィールド設定」の値として作成されます。

たとえば、「条件 / 変数」で「ヘッダー」、「ボディプレフィックス」、または「変数の一致」フィールドを選択し、正規表現の構文 (?P<name>...) を使用して現在の値をキャプチャすることができます。

キャプチャ変数の利用目的

これは、KurocoEdge で変数を「オンザフライ」で作成するための便利で非常に柔軟な方法です。これらのキャプチャ変数は、アクションの「実行」セクション内で他の KurocoEdge 変数と同様に {$variable} の構文を使用して再利用することができます。

よくある使用例は、値をキャプチャしてそれをパラメータとして URL に挿入することです(例: データを取得するための API 呼び出し時にパラメータとして挿入する場合)。

備考

キャプチャ変数の作成と使用方法についてのチュートリアルは、以下のドキュメントを参照してください。

キャプチャされた変数を使用する

API変数

KurocoEdge での最も高度な変数の形式は、API変数です。これにより、API エンドポイントから取得した値を変数に割り当てることができます。API変数は、スタティック変数と同様にアクションの「実行」セクション内で使用することができます。ただし、API のデータはしばしばネストされた値を持つオブジェクトであるため、API変数への値の割り当てはより複雑になる場合があります。

ネストされた値にアクセスするためには、ドット記法を使用する必要があります。

たとえば、address という名前の API変数(オブジェクト)には、street というネストされた値が含まれている場合、「実行」セクションで使用する正しい構文は次のとおりです:

{$address.street}

通常、API変数を使用する場合、トップレベルの文字列値(オブジェクト内のトップレベルのキー/値ペアから返される値)を返すか、ドット記法を使用してネストされた文字列値を返すことがベストプラクティスです。

API変数の利用目的

API のレスポンスオブジェクトを操作することは複雑で扱いにくい場合があります。値(またはネストされた値)を変数に割り当てることで、作業が容易になります。たとえば、値を URL のパラメータとして挿入する必要がある場合や、API エンドポイントから動的なデータを取得する必要がある場合などです。

備考

API変数の作成と使用方法についてのチュートリアルは、以下のドキュメントを参照してください。

API変数を使用する


サポート

お探しのページは見つかりましたか?解決しない場合は、問い合わせフォームからお問い合わせいただくか、Discordコミュニティにご参加ください。