フォームにおける API タスクの呼び出し

API タスク を呼び出すフォームを作成し、API タスク 変数をフォームの必須フィールドにマッピングします。

前提条件

  • Bot Creator ライセンスが必要です。
  • フォームから呼び出すには、まず API タスクを作成する必要があります。
このトピックでは、フォームにおける API タスクの呼び出し方法について説明します。この例では、入力された郵便番号に基づいて場所と州の詳細を取得する API タスクを呼び出す郵便番号フォームを作成します。作成したフォームは、プロセスを通して実行できます。自分の事例に特化したフィールドを持つフォームを作成することができます。

手順

  1. API タスク を呼び出したい既存のフォームに移動するか、新しいフォームを作成します。詳細については、「フォームの作成」を参照してください。
    このフォームに「郵便番号フォーム」という名前を付けます。
  2. フォームの設計: フォーム要素を使用して、事例に基づいたインタラクティブ フォームを構築します。この例では、フォームは API タスクから郵便番号変数をマッピングするように設計されています。
    1. [要素] 列から、[テキスト ボックス] 要素をドラッグして、フォーム デザイナーにドロップします。
      画面右側に、関連するフィールドとともに [プロパティ] タブが表示されます。
    2. [要素ラベル] に入力します。次に例を示します。たとえば、[郵便番号] です。
    3. 必要に応じて、最小および最大の [文字数制限] を入力します。たとえば、[最小] フィールドに 1、[最大] フィールドに 5 を入力します。
    4. さらに 2 つの [テキスト ボックス] の要素をドラッグして、「場所」と「州」という名前を付けます。
    5. [要素] 列から、[ボタン] 要素をドラッグして、フォーム デザイナーにドロップします。[ボタンのテキスト (必須)] フィールドに、このボタンの名前を入力します (例: リセット)。次の画像は、完了フォームを示します。
      郵便番号 API タスクの例
  3. [フォーム ルール] を追加します。フォーム ルールは、フォームの各要素に必要な条件を提供します。フォーム ルールをif 条件およびthen 条件を使用して設定し、条件が満たされたときに実行されるアクションを指定できます。この例では、郵便番号要素の値が 5 以上でなければならないようにフォーム ルールが構成されています。この条件が満たされる場合、場所と州の要素ボックスは API タスク変数から値を取得します。実行中に、フォーム ルールの条件が満たされない場合、API タスクは期待通りに動作しません。
    1. [フォーム ルール] タブをクリックします。
    2. 必要に応じて、ルールの名前を入力します(例: API タスク 呼び出し)。
    3. [If] 条件を入力し、入力された郵便番号を検証します。たとえば、入力された郵便番号が 5 文字以上であるかどうかを確認することができます。
      郵便番号のサンプル API タスク チェック (5 文字以上)
    4. Then 節を定義するには、[フォーム アクション] を選択し、ドロップダウンから、[API 呼び出しから値を取得] を選択します。
      郵便番号 API タスク フォームの Then 条件
    5. API タスク に関連する変数をフォームにマッピングするには、[変数マッピングを追加] オプションを使用します。
      注: タスクをチェックインした後に公開されている API タスク を編集して変数を追加した場合、その変数はフォームに表示されません。変数を追加した後で、API タスク をチェックインする必要があります。
    6. [参照] をクリックして、固有の API タスク を選択し、指定の操作を実行します。この例では、API タスク (郵便番号タスク) が選択されており、任意の郵便番号の場所と状態を取得できます。
  4. [リセット] ボタンにルールを追加します。この例では、[リセット] ボタンをクリックするとすべてのフィールドの値が消去されるように、リセット ボタンのフォーム ルールが定義されています。
    1. [ルールを追加] ボタンをクリックします。
    2. [If] 条件を入力し、ボタンの [クリック] 状態をキャプチャします。この条件は、ボタンがクリックされるたびに true になります。
      郵便番号のサンプル API タスク チェック (5 文字以上)
    3. [Then] 節を定義するには、[アクションを追加] をクリックし、[要素を選択] ドロップダウンをクリックして、[リセット] ボタンをクリックすると消去される [テキストボックス] 要素をすべて選択します。
      郵便番号 API タスク フォームのリセット
    4. [要素を選択] ドロップダウンの下のドロップダウンをクリックし、[値を消去] を選択します。
      注: フォーム内の API タスク を 1 つのセッションで何度も呼び出すと、エラーが発生することがあります。このエラーを解決するには、既存の値をクリアするためのリセットボタンをフォームに追加します。