WidgetAnalyticsInfoReportedArgs.AnalyticsJson プロパティ

定義

名前空間:: Microsoft.Windows.Widgets.Providers

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

編集

分析イベントをトリガーしたユーザー操作を記述する JSON 文字列を取得します。

public:
 property Platform::String ^ AnalyticsJson { Platform::String ^ get(); };

winrt::hstring AnalyticsJson();

public string AnalyticsJson { get; }

var string = widgetAnalyticsInfoReportedArgs.analyticsJson;

Public ReadOnly Property AnalyticsJson As String

プロパティ値

String

Platform::String

winrt::hstring

JSON 文字列。

注釈

このプロパティによって返される JSON 文字列は、次の形式を使用します。

{
 "host": "dashboard.microsoft.com",
 "version": "1.0",
 "eventKind": "interaction",
 "interactionKind": "titleLink",
 "url": "https://www.contoso.com"
}

テレメトリデータは、3 種類のイベント、ユーザー操作、終了のカスタマイズ、および可視性イベントに対して提供されます。次のセクションでは、イベントの種類ごとに JSON テレメトリデータ形式の形式に関する詳細情報を提供します。

EventKind - 相互作用

対話イベントは、ユーザーがウィジェットまたはそのコンテナーと対話するときに発生します。この種類のイベントによってテレメトリデータがトリガーされると、 eventKind の値は "interaction" になります。

TitleBar

このイベントは、ユーザーがウィジェットのタイトルバーをクリックしたときに発生します。イベントは、タイトルバーを簡単にクリックするか、ホストアプリ内の新しい位置にウィジェットをドラッグすることによってトリガーされます。

プロパティ	価値
ホスティング	エラー情報を送信しているホストを識別する文字列。
バージョン	JSON ペイロードスキーマのバージョン。
eventKind	"interaction"
interactionKind	"titleBar"

TitleBar イベントの JSON ペイロードの例。

{
    "host": "dashboard.microsoft.com",
    "version": "1.0",
    "eventKind": "interaction",
    "interactionKind": "titleBar"
}

コンテキストメニュー

このイベントは、ユーザーが省略記号 "..." の下のアクションの 1 つをクリックしたときに発生します。ボタンをクリックします。

プロパティ	価値
ホスティング	エラー情報を送信しているホストを識別する文字列。
バージョン	JSON ペイロードスキーマのバージョン。
eventKind	interaction"
interactionKind	"contextMenu"
clickedItem	クリックしたメニュー項目の名前 (例: "customize"、"unpin"、"attribution"、"feedback"、"additionalInfo"

ContextMenu イベントの JSON ペイロードの例。

{
    "host": "dashboard.microsoft.com",
    "version": "1.0",
    "eventKind": "interaction",
    "interactionKind": "contextMenu",
    "clickedItem": "feedback"
}

ハイパーリンク

このイベントは、ユーザーがウィジェット内のハイパーリンクをクリックしたときに発生します。たとえば、 TextBlock のマークダウンリンクをクリックすると発生します。 URL ナビゲーションはウィジェットホストによって処理され、プロバイダーはハイパーリンク内を移動する必要はありません。

プロパティ	価値
ホスティング	エラー情報を送信しているホストを識別する文字列。
バージョン	JSON ペイロードスキーマのバージョン。
eventKind	"interaction"
interactionKind	ハイパーリンク
url	リンク先。

Hyperlink イベントの JSON ペイロードの例。

{
    "host": "dashboard.microsoft.com",
    "version": "1.0",
    "eventKind": "interaction",
    "interactionKind": "hyperlink",
    "url": "https://www.contoso.com"
}

AdditionalInfoUri

このイベントは、ユーザーがウィジェットの AdditionalInfoUri を起動したときに発生します。たとえば、ユーザーがダッシュボードのウィジェットタイトルをクリックすると、外部ナビゲーションが発生します。

プロパティ	価値
ホスティング	エラー情報を送信しているホストを識別する文字列。
バージョン	JSON ペイロードスキーマのバージョン。
eventKind	"interaction"
interactionKind	"additionalInfoUri"
Uri	ユーザーがウィジェットの AdditionalInfoUri を起動したときにナビゲーション用に登録された URI。たとえば、ダッシュボードでウィジェットのタイトルをクリックするとします。

AdditionalInfoUri イベントの JSON ペイロードの例。

{
    "host": "dashboard.microsoft.com",
    "version": "1.0",
    "eventKind": "interaction",
    "interactionKind": "additionalInfoUri",
    "uri": "https://www.contoso.com"
}


#### Action.OpenUrl

This event is raised when a user clicks on an [Action.OpenUrl](https://adaptivecards.io/explorer/Action.OpenUrl.html) action.

| Property | Value |
|----------|-------|
| host | String that identifies the host sending the error info.|
| version | Version of the JSON payload schema.|
| eventKind | "interaction"|
| interactionKind | "action.openUrl"|
| actionId | Id of the AdaptiveCard action clicked.|
| actionTitle | Title of the AdaptiveCard action clicked.|
| Url | Value set in the Action.OpenUrl url property.|

Example JSON payload for a *Action.OpenUrl* event.
```json
{
    "host": "dashboard.microsoft.com",
    "version": "1.0",
    "eventKind": "interaction",
    "interactionKind": "action.openUrl",
    "actionId": "ContosoAction",
    "actionTitle": "Go to home screen",
    "url": "https://www.contoso.com"
}

Action.ToggleVisibilty

このイベントは、ユーザーが Action.ToggleVisibility アクションをクリックしたときに発生します。

プロパティ	価値
ホスティング	エラー情報を送信しているホストを識別する文字列。
バージョン	JSON ペイロードスキーマのバージョン。
eventKind	"interaction"
interactionKind	"action.toggleVisibility"
actionId	クリックされた AdaptiveCard アクションの ID。
actionTitle	クリックされた AdaptiveCard アクションのタイトル。
elementIds	targetElements プロパティで定義されている Action.ToggleVisibility の対象となる要素の一覧。

Action.ToggleVisibilty イベントの JSON ペイロードの例。

{
    "host": "dashboard.microsoft.com",
    "version": "1.0",
    "eventKind": "interaction",
    "interactionKind": "action.toggleVisibility",
    "actionId": "ToggleAction",
    "actionTitle": "Show meat options",
    "elementIds": ["ImageChicken", "ImageSteak"]
}

Note

AdaptiveCards ライブラリの制限により、 elementIds 値に完全な情報が含まれていない場合があります。たとえば、非表示のコンテナーの下の要素は、コンテナーが表示されない限り表示されません。

アクション.ショウカード

このイベントは、ユーザーが Action.ShowCard アクションをクリックしたときに発生します。

プロパティ	価値
ホスティング	エラー情報を送信しているホストを識別する文字列。
バージョン	JSON ペイロードスキーマのバージョン。
eventKind	"interaction"
interactionKind	"action.showCard"
actionId	クリックされた AdaptiveCard アクションの ID。
actionTitle	クリックされた AdaptiveCard アクションのタイトル。

Action.ShowCard イベントの JSON ペイロードの例。

{
    "host": "dashboard.microsoft.com",
    "version": "1.0",
    "eventKind": "interaction",
    "interactionKind": "action.showCard",
    "actionId": "ShowAnotherCardAction",
    "actionTitle": "See more details"
}

回転木馬

このイベントは、ユーザーがカルーセル要素を操作するときに発生します。たとえば、カルーセル内の特定のページをクリックしたときや、左右の矢印を使用して移動するときなどです。

プロパティ	価値
ホスティング	エラー情報を送信しているホストを識別する文字列。
バージョン	JSON ペイロードスキーマのバージョン。
eventKind	"interaction"
interactionKind	"カルーセル"
activePageId	AdaptiveCards カルーセルページ ID。
activePageIndex	現在アクティブなページのインデックス。
carouselId	AdaptiveCards カルーセルの ID。
carouselEventName	String、"navigationNext"、"navigationPrevious"、"pagination"、または "autoplay" のいずれか
carouselEventKind	カルーセルイベント名のいずれかにマップされる数値。値は次のようにマップされます。navigationNext - 0、navigationPrevious - 1、改ページ位置 - 2、自動再生 - 3

カルーセルイベントの JSON ペイロードの例。

{
    "host": "dashboard.microsoft.com",
    "version": "1.0",
    "eventKind": "interaction",
    "interactionKind": "carousel",
    "activePageId": "MainPage",
    "activePageIndex": 0,
    "carouselId": "FeaturesCarousel",
    "carouselEventName": "navigationPrevious",
    "carouselEventKind": 1
}

exitCustomization

このイベントは、ウィジェットフレームのコンテキストメニューから [カスタマイズ] メニュー項目をクリックしてカスタマイズモードに入った後、ユーザーがカスタマイズモードを終了したときに発生します。この種類のイベントによってテレメトリデータがトリガーされると、 interactionKind の値は "exitCustomization" になります。

プロパティ	価値
ホスティング	エラー情報を送信しているホストを識別する文字列。
バージョン	JSON ペイロードスキーマのバージョン。
eventKind	"interaction"
interactionKind	"exitCustomization"

exitCustomization イベントの JSON ペイロードの例。

{
    "host": "dashboard.microsoft.com",
    "version": "1.0",
    "eventKind": "interaction",
    "interactionKind": "exitCustomization"
}

EventKind - 可視性

可視性イベントは、ウィジェットが表示されているビューポートに移動または非表示になったときに発生します。可視性イベントは物理的な印象に関連付けられており、ホストがいつでもトリガーできる IWidgetProvider インターフェイスのアクティブ化および非アクティブ化 API とは異なる場合があります。この種類のイベントによってテレメトリデータがトリガーされると、 eventKind の値は "visibility" になります。

プロパティ	価値
ホスティング	エラー情報を送信しているホストを識別する文字列。
バージョン	JSON ペイロードスキーマのバージョン。
eventKind	"visibility"
visibilityKind	"visible" または "hidden"

可視性イベントの JSON ペイロードの例。

{
    "host": "dashboard.microsoft.com",
    "version": "1.0",
    "eventKind": "visibility",
    "visibilityKind": "visible"
}

適用対象

フィードバック

このページはお役に立ちましたか?