オートアシストやアクションフローで使用するアクションの作成

現在のプランを確認

Suite

Growth、Professional、EnterpriseまたはEnterprise Plus

アクションは、設定可能な自動化タスクです。これらのタスクは、エージェントCopilotに含まれるオートアシスト機能によって実行されるか、事前に定義された一連の自動化タスクを実行するアクションフローによって実行されます。

この記事では、以下のトピックについて説明します。

アクションの作成でのベストプラクティス
外部アクションを作成する
アクションをテストする
次のステップ

アクションの作成でのベストプラクティス

アクションを作成する際は、以下のベストプラクティスに従ってください。

認証にコネクションを使用すること。アクションの設定に認証情報を含めてはなりません。コネクションは機密情報を安全に保護するように設計されているので、コネクションを使用してください。
アクセス権限に細心の注意を払うこと。コネクションは、エージェントやエンドユーザーよりもアクセス権限が大きい可能性があることに留意してください。アクション、プロシージャ、エージェントのトレーニングを設定することで、機密データを誤ったユーザーに共有してしまうことを防ぎます。
データは可能な限り非公開にすること。アクションのレスポンスの一部を出力として取得するときは、必要な特定のデータポイントだけを取得するように注意してください。目の前のタスクに直接関係のないデータを取得することは、適切なプライバシー保護対策とはいえず、さらにオートアシストを混乱させる可能性があります。
アクション、入力、出力の名前と説明の記述は平易なものにすること。名前と説明は、アクション（その入力と出力を含む）がカスタマーのリクエストに関連するとき、オートアシストが判断するのに役立ちます。また、既存のアクションに変更を加える場合は、名前と説明が変えられていないことを確認してください。
名前と説明は、アクションの意味と結果を明確に説明していなければなりません。例：
- アクションの名前：本をカートに追加する
- アクションの説明：カスタマーのショッピングカートに本を追加します。
オートアシスト手順でアクションを参照する際は、特定のアクションを呼び出すために類似した表現を使うようにしてください。
- 例：「購入したい本をカスタマーが確認したら、その本をカートに追加する。」
入力がない場合への対処を明記すること。入力のない状況が考えられる場合は、その状況での対処方法を説明に含めてください。たとえば、すべてのリクエスタがメールアドレスを持っているとは限りません。したがって、requester_email_addressという入力に対する説明は、「チケットを開始したエンドユーザーのメールアドレス」となる場合もあります。これが利用できない場合は、「応対不可」を使ってください」。
アクションとアクションフローの名前および説明は、明確に区別すること。両方を使用する場合、それぞれに使う名前をしっかりと区別しておくことが重要です。アクションとアクションフローは管理センター内の異なる場所で管理されていますが、オートアシストはどちらも確認し、同等のものとして扱います。
たとえば、「order refund」という名前のアクションと、「refund order」という名前のアクションフローがある場合、それぞれの説明は明確に区別できるよう詳しい説明を提供する必要があります。両方の説明があいまいだと、オートアシストが誤ったものを提案したり、両方を選択してしまう可能性があります。

アクションの制限

アクションには以下の制限が適用されます。

作成できるアクションは1アカウントにつき最大100個まで。
各アクションの入力と出力は、それぞれ最大100回まで。
外部アクションのタイムアウトは10秒。外部システムからの応答が10秒以上かかったり、その応答をZendeskアカウントで受信できなかったりした場合、そのアクションは実行されない。
外部アクションの最大応答サイズは2MB。
2025年3月13日以前に作成されたアクションは、更新して保存しない限り、アクションフローのステップに利用できません。

外部アクションを作成する

管理者は管理センターで新しい外部アクションを作成できます。外部アクションには、入力、APIコール、出力が必要です。

入力：アクションを実行するために使用する情報です。定義した各入力によって作成される入力プレースホルダは、アクションのURL、ボディ、クエリパラメータ、ヘッダーに挿入できます。
オートアシストは、アクションを実行するときに、これらのプレースホルダをデータに置き換えます。アクションフローでは、プレースホルダをステップ内のさまざまなプロパティで使用できます。
APIコール：情報をAPIに送信する際にどのように正確に構造化するかを示すものです。
出力：APIから返されたデータをZendeskがどのように解釈するかを決定します。定義した出力は、アクションが実行されたときにAPIレスポンスのどの部分をオートアシストに送り返すかをアクションに伝えます。

外部アクションを作成するには

管理センターで、サイドバーにある「 アプリおよびインテグレーション」をクリックし、「アクション」>「アクション」を選択します。
「アクションを作成」をクリックします。
「名前」フィールドに、アクションのわかりやすい名前を入力します。
この名前はエージェントやイベントログに表示されます。
「説明」フィールドに、アクションの説明を入力します。
この説明は、システムがそのアクションをオートアシストとともに使用するタイミングを判断するために利用されます。説明の適切な書き方について詳しくは、「アクションの作成でのベストプラクティスを」参照してください。
「入力」セクションで、「入力を追加」をクリックします。
1. 「入力を追加」ウィンドウで、以下のフィールドに入力します。
  - 名前：わかりやすい名前を指定します。
  - 説明：入力の説明を指定します。
  - タイプ：以下のオプションのいずれかを選択します。文字列、整数、少数、またはブール値。
    入力するデータタイプは厳密に適用されます。たとえば、「3.0」は整数として受け入れられず、文字列「true」はブール値として受け入れられず、ブール値「false」は文字列として受け入れられません。
2. 「入力を追加」をクリックします。
「API設定」パネルで、以下のフィールドに入力します。
1. リクエスト方法：実行するアクションに応じて、GET、POST、PATCH、PUT、DELETEのいずれかを選択します。
2. エンドポイントURL：外部サービスのURLを入力します。
  入力できるURLは、https:// URLSのみです。
3. 認証：既存のAPIコネクションを選択します。
4. ボディ：このAPIコールでリクエストする情報を入力します。
  作成した入力のいずれかにプレースホルダを挿入するには、{+}をクリックし、該当する入力を選択します。
5. クエリパラメータ：「パラメータを追加」をクリックし、このAPIコールに適用するパラメータにキーと値を追加します。
6. ヘッダー：「ヘッダーを追加」をクリックし、このAPIコールに適用するパラメータに名前と値を追加します。
  content-typeヘッダーの追加は必要ありません。application/json値のみがサポートされ、このヘッダーはAPIコールの実行時に自動的に追加されます。
「出力」セクションで、「出力を追加」をクリックします。
1. 「出力を追加」ウィンドウで、設定した各入力のテストデータを入力します。
2. 「APIコールを実行」をクリックします。
  このデータは外部サービスに送信され、代表的なレスポンスが返されます。
  
  メモ：外部アクションが実行される場合、レスポンスはJSONでなければならず、適切なJSONヘッダー（content-type: application/json）が必要です。他のJSON互換コンテンツタイプ（vnd.oracle.resource+jsonやvnd.api+jsonなど）は、現在サポートされていません。
3. 「出力」タブで、レスポンスから適切な出力を見つけ、「追加」をクリックします。
  「レスポンスボディ」タブをクリックすると、実際のレスポンスがどのようにフォーマットされているかを見ることができます。
4. 出力の「名前」と「説明」を入力し、「出力を追加」をクリックします。
5. オートアシストに返したいすべての出力を取得するため、必要に応じて手順を繰り返します。
6. 「完了」をクリックします。
  アクションが実行されたときに、対応する出力がレスポンスに含まれていない場合、アクションは成功しますが、出力のキーはオートアシストに返されるレスポンスからは省かれます。
「保存」をクリックします。

アクションをテストする

アクションを作成したら、テストを実施して期待どおりに動作することを確認します。必要であれば、さまざまな出力をテストするために、異なる入力値で複数回テストを実行します。

アクションをテストするには

管理センターで、サイドバーにある「 アプリおよびインテグレーション」をクリックし、「アクション」>「アクション」を選択します。
編集するアクションで、オプションメニュー（）をクリックして、「テスト」を選択します。
「テスト」タブの「入力」セクションに、設定した各入力のテストデータを入力します。
「APIコールを実行」をクリックします。
このデータは外部サービスに送信され、代表的なレスポンスが返されます。
「出力セクションで、レスポンスに期待するデータが含まれていることを確認します。

テスト中に問題が発生した場合は、以下のトラブルシューティングを行ってみてください。

外部アクションを使って外部システムとデータをやりとりしている場合は、詳細なトラブルシューティングには、その製品のドキュメントを参照するのが最適です。
テスト中に遭遇する可能性のあるHTTPエラーコードの概要については、HTTPレスポンスステータスコードを参照してください。
すべての入力と出力が、用途に適したデータのタイプ（整数、小数、文字列、またはブール値）であることを確認してください。
実行されたアクションの詳細については、インテグレーションのログで確認することができます。

次のステップ

アクションを作成してテストしたら、次の操作を実行できます。