外部APIアクションタイプの呼び出し
重要 - 画像/情報は四半期ごとのリリースで更新されます!
四半期ごとのリリースにて、最新の機能・情報を反映し、画像を含めた情報は更新されます。
この記事では、管理者がルールエンジンで「外部APIの呼び出し」アクションタイプを使用する方法について説明します。
概要
管理者は、ルールエンジンの「外部APIの呼び出し」アクションタイプにより、APIを介した外部システムからのリクエストアクションでGainsightと外部システムとの間の接続を確立することができます。
Gainsightでは、この記事を読む前に、ルールの詳細の設定、データ設定、スケジュールのステップについて読んでおくことを推奨しています。詳細については、ルールエンジンのHorizonエクスペリエンスの概要 の記事にある新規ルールの作成のセクションを参照してください。
前提条件
外部アクションおよびカスタムコネクタは、外部アクションページで設定する必要があります。
外部アプリケーションへの接続を設定したら、外部アクションページでアクションを作成できます。
詳細については、Gainsightからの外部アクションの設定 (近日公開予定) の記事にあるカスタムコネクタの設定と外部アクションの設定のセクションを参照してください。
「外部APIの呼び出し」アクションの設定
「外部APIの呼び出し」アクションタイプを設定するには:
- アクション設定のステップで、データセットにカーソルを移動します。アクションの追加アイコンが表示されます。
- アクションの追加アイコンをクリックします。クライテリアの追加スライドアウトパネルが表示されます。
- (オプション)クライテリアの追加をクリックして、データセットの条件を設定します。アクション項目は条件が満たされた場合にのみ実行されます。
- (オプション)続行をクリックします。「アクションの追加」スライドアウトパネルが表示されます。
- クライテリアの追加スライドアウトパネルで、次の詳細を指定します。
- クライテリア名: 名前を入力します。
- フィールド:フィールドドロップダウンリストからフィールドを選択します。
- 入力タイプ: 入力タイプドロップダウンリストから入力を選択します。
- 演算子: 演算子ドロップダウンリストから演算子を選択します。
- 値: 数値を入力します。
- +アイコン: +アイコンをクリックしてフィールドを追加します。
- Xアイコン: Xアイコンをクリックしてフィールドを削除します。
- 高度なロジック: ここに高度なロジックを入力します。
- 続行をクリックして、アクションの追加のステップに移動します。
- アクションの作成ドロップダウンリストから「外部APIの呼び出し」アクションタイプを選択します。外部APIの呼び出し設定スライドアウトパネルが表示されます。
- 外部APIの呼び出し設定スライドアウトパネルで、次の詳細を指定します。
- コネクタドロップダウンリストからコネクタを選択します。
- 外部アクションドロップダウンリストから外部アクションを選択します。
- (オプション)ルールアクションの説明を入力します。
- URL: 管理者は表示モードでURL を見ることができます。
- フィールドマッピング: ソースフィールドドロップダウンリストからソースフィールドを選択して、外部アクションフィールドをソースフィールドにマッピングします。
- (オプション)ソースフィールドドロップダウンリストでカスタム静的値の追加をクリックして、カスタム値を入力します。
- (オプション)接続の作成をクリックし、新しい接続を作成します。
- アクションを保存をクリックします。「外部APIの呼び出し」アクションが正常に保存されます。
アクションの作成
アクションを作成するには:
- (オプション)アクションの作成をクリックし、新しいアクションを作成します。「アクションの作成」スライドアウトパネルが表示されます。
- コネクタドロップダウンリストからコネクタを選択します。
- アクション名を入力します。
- メソッドドロップダウンリストからメソッドを選択します。
- URLを入力します。
- ペイロードを展開して、必要なオプションを選択します。
- ヘッダー情報を展開して、コンテンツタイプ、application/jsonを入力します。
- ペイロード、URL、およびヘッダーセクションが記入されると、フィールドセクションが自動的に入力されます。
- 高度な設定の情報を展開して、試行回数の最大制限値を入力します。
- 保存をクリックします。
「外部APIの呼び出し」アクションのクローニング
クローンアイコンをクリックします。アクション項目のクローンが作成されます。
削除
削除アイコンをクリックします。アクション項目が削除されます。
その他のリソース
- Gainsightからの外部アクションの設定 (近日公開予定)
- ルールエンジンのHorizonエクスペリエンスの概要