プログラムでAPIアクション タイプを呼び出し
重要 - 画像/情報は四半期ごとのリリースで更新されます!
四半期ごとのリリースにて、最新の機能・情報を反映し、画像を含めた情報は更新されます。
この記事では、ジャーニーオーケストレーターでExternal API Actionタイプを使用する方法について説明します。
概要
プログラムの新しいアクションタイプ 「コールAPI」 は、外部コールアウトフレームワークと統合し、ユーザーが使用するすべての接続を一覧表示するために使用されます。このアクションタイプは、ジャーニーオーケストレーターのすべてのモデルタイプでサポートされています。管理者は、外部コネクタとそれぞれのアクションを選択でき、外部コールアウトから動的トークンフィールドに入力する参加者フィールドとトークンも選択できます。
主なユースケースは、外部APIを呼び出し、Gainsight CSで発生するイベントに基づいてパラメータを更新することです。以下は一部の例です:
- NPS®サーベイを送信し、その回答をコラボレーションツール(Slack)に投稿。
- このアクションタイプは、ジャーニーオーケストレーターのすべてのモデルタイプでサポートされています。
- プログラム内で作成したCTAが閉じられて失われた場合に、外部のチケットシステム(Zendesk)におけるケースの作成/更新。
- 主なユースケースは、外部APIを呼び出し、Gainsight CSで発生するイベントに基づいてパラメータを更新することです。
- Gainsight CSで発生したイベントをベースにして、顧客/関係/個人のデータを外部データシステムに更新し、その他のアクションを実行すること。
- 顧客ヘルススコアがX%低下したときに、外部システムにアラートを送信し、CTAを作成するなどのアクションを実行します。
注記: デフォルトでは、この機能は有効になっていません。この機能を有効にするには、support@gainsight.comにお問い合わせください。
管理者は、ウェイトタイマーまたは条件付き待機ステップの後に+をクリックして、Call APIステップを追加できます。
前提条件
外部システムとの接続を確立するには、いずれかの認証方式を使用する必要があります。これらの認証方式の詳細については、 「API 認可方法」 を参照してください。この設定は、ページにあるウィジェットから実行できます。
外部アプリケーションとの接続を確立したら、必要に応じてAPIメッセージを設定できます。API構造を確定すると、外部 API を呼び出すアクションタイプでAPIを使用できます。API設定は、Gainsightのページから実行できます。
前提条件の設定方法の詳細については、 「Gainsightからの外部アクションの設定」 の記事を参照してください。
コールAPIステップの作成
カスタム接続と外部アクションを作成および設定すると、アクションタイプがジャーニーオーケストレーターに表示されるようになります。
外部APIを呼び出し、Gainsight CSで発生するイベントに基づいてパラメータを更新するためのCall APIステップを作成します。
Call APIステップを設定するには、次の手順を実行します。
- +をクリックして新しいアクションを追加し、Call APIを選択します。
- Call APIステップにカーソルを合わせ、編集アイコンをクリックします。[呼び出す外部 API を構成する] ページが表示されます。
- および [外部 API] ドロップダウンオプションから、 [外部アクション] ページで設定されている適切なコネクタと外部APIタイプを選択します。
- その外部コネクタに選択されているフィールドの値を入力します。
注記: データが定義されていない場合、管理者はカスタム値を入力することもできます。
- 保存をクリックします。
注意:プレビューをクリックしてAPI呼び出しをテストし、Test APIの一部として応答も表示します。
Call APIステップは、ジャーニーの公開後に変更できます。これは、このステップにまだ参加していないすべての参加者にすぐに適用されます。
エラーが発生した場合、管理者は参加者をドロップするか、参加者の移動を続行するかを選択できます。
実行中、外部APIコールアウトの詳細は分析用にデータベースに格納されます。
制限
- プログラムでCall APIアクションタイプを使用する場合、参加者の数が多いと参加者のリストを取得するのに通常よりも時間がかかります。
NPS、ネットプロモーター、ネットプロモータースコアは、Satmetrix Systems, Inc.、ベインアンドカンパニー、フレッドライヒヘルドの登録商標です。 |