次の方法で共有

executeEvent (クライアント API 参照) (プレビュー)

重要

  • これはプレビュー機能です。
  • プレビュー機能は運用環境での使用を想定しておらず、機能が制限されている可能性があります。 これらの機能は、追加の使用条件の対象となり、正式リリース前に利用可能です。お客様は早期にアクセスし、フィードバックを提供することができます。

登録されたイベント名に基づいて、Microsoft Copilot Studio トピックを実行します。 MCSResponse タイプの配列を返します。

構文

Xrm.Copilot.executeEvent(eventName, eventParameters).then(successCallback, errorCallback);

Parameters

パラメーター名 タイプ Required プロパティ
eventName 文字列 はい Microsoft Copilot Studio トピックに登録されたイベント名
eventParameters Unknown はい イベントの実行に必要なパラメーター。 これらは、トピックが何をするかによって異なります。
successCallback Function はい 処理が成功したときに呼び出す関数。
errorCallback Function はい 処理が失敗したときに呼び出す関数。

戻り値

MCSResponse の配列

アプリのコンテキストへのアクセス

エージェント API が呼び出されると、アプリのコンテキストが一連の変数を通じて Copilot Studio トピックに渡されます。 以下は、Copilot Studio グローバル変数として使用できるコンテキスト変数です。

変数 プロパティ
Global.PA__Copilot_Model_PageContext.pageContext.id.guid メイン フォームのテーブル レコードの ID
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName メイン ページのテーブルの論理名
Global.PA__Copilot_Model_PageContext.pageContext.pageName メイン ページの名前
Global.PA__Copilot_Model_PageContext.pageContext.pageType メイン ページの種類
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName モデル駆動型アプリの一意の名前

たとえば、Global.PA__Copilot_Model_PageContext.pageContext.id.guid と Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName を使用すると、フォームのレコードは Dataverse から取得できます。

eventParameters へのアクセス

Copilot Studio のトピック内では、API 呼び出しの eventParameters は変数 Activity.Value を使用してアクセスできます。 値ノードの解析 を使用して、JSON を 1 つ以上のフィールドを持つレコードに変換します。 データ型にサンプル データからを選択すると、レコードを作成するための JSON サンプルを提供できます。

例

Microsoft Copilot Studio では、ID (エンティティ レコード ID) を入力パラメーターとして受け入れるトピックが登録されています。 入力に基づき、そのエンティティ レコードの関連アクティビティを検索し、その結果を Copilot Studio イベント活動として返します。

const response = await Xrm.Copilot.executeEvent( 
    "Microsoft.PowerApps.Copilot.RelatedActivities", 
    { id:"aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"});

回答

[
    {
        "type": "event",
        "timestamp": "2025-02-05T16:05:53.4074714+00:00",
        "replyToId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
        "attachments": [],
        "value": {
            "@odata.context": "https://*.dynamics.com/api/data/v9.2/$metadata#activitypointers(subject,prioritycode)",
            "value": [
                {
                    "@odata.etag": "W/\"6825587\"",
                    "@odata.type": "#Microsoft.Dynamics.CRM.phonecall",
                    "activityid": "cccccccc-2222-3333-4444-dddddddddddd",
                    "activitytypecode": "phonecall",
                    "prioritycode": 2,
                    "subject": "Discuss new opportunity (sample)"
                },
                {
                    "@odata.etag": "W/\"6826236\"",
                    "@odata.type": "#Microsoft.Dynamics.CRM.phonecall",
                    "activityid": "dddddddd-3333-4444-5555-eeeeeeeeeeee",
                    "activitytypecode": "phonecall",
                    "prioritycode": 2,
                    "subject": "Likes our new products (sample)"
                }
            ]
        },
        "name": "MS.CopilotApiDemo.RelatedActivities"
    }
]

Xrm.Copilot (クライアント API 参照)

  • Last updated on