デスクトップ アプリケーションのインサイト データの取得
Windows デスクトップ アプリケーション プログラムに追加したデスクトップ アプリケーションの状態メトリックに関連する分析情報データを取得するには、Microsoft Store 分析 API のこのメソッドを使用します。 このデータは、パートナー センターにあるデスクトップ アプリケーションの状態レポートでも確認できます。
前提条件
このメソッドを使うには、最初に次の作業を行う必要があります。
- Microsoft Store 分析 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。
- このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。 アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れたら新しいトークンを取得できます。
要求
要求の構文
| 認証方法 | 要求 URI |
|---|---|
| GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/insights |
要求ヘッダー
| Header | 型 | 説明 |
|---|---|---|
| 承認 | string | 必須。 Bearer<トークン> という形式の Azure AD アクセス トークン。 |
要求パラメーター
| パラメーター | 型 | 内容 | 必須 |
|---|---|---|---|
| applicationId | string | 分析情報を取得するデスクトップ アプリケーションの製品 ID です。 デスクトップ アプリケーションの製品 ID を取得するには、パートナー センターでデスクトップ アプリケーションの分析レポートのいずれか (状態レポートなど) を開き、URL から製品 ID を取得します。 このパラメーターを指定しない場合、応答本文には、アカウントに登録されているすべてのアプリのインサイト データが含まれます。 | いいえ |
| startDate | 日付 | 取得する分析情報データの日付範囲の開始日です。 既定値は、現在の日付の 30 日前です。 | いいえ |
| endDate | 日付 | 取得する分析情報データの日付範囲の終了日です。 既定値は現在の日付です。 | いいえ |
| filter | string | 応答内の行をフィルター処理する 1 つまたは複数のステートメントです。 各ステートメントでは応答本文のフィールド名と値が eq 演算子または ne 演算子で関連付けられ、ステートメントは and または or を使用して組み合わせることができます。 filter パラメーターでは、文字列値を単一引用符で囲む必要があります。 たとえば、filter=dataType eq 'acquisition' です。 現在、このメソッドはフィルター healthのみをサポートしています。 |
いいえ |
要求の例
次の例は、分析情報データを取得する要求を示しています。 applicationId の値は、デスクトップ アプリケーションに対する適切な値に置き換えてください。
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/insights?applicationId=10238467886765136388&startDate=6/1/2018&endDate=6/15/2018&filter=dataType eq 'health' HTTP/1.1
Authorization: Bearer <your access token>
回答
応答本文
| 値 | 種類 | 説明 |
|---|---|---|
| 値 | 配列 | アプリの分析情報データを含むオブジェクトの配列です。 各オブジェクトのデータの詳細については、後の「分析情報の値」セクションを参照してください。 |
| TotalCount | int | クエリの結果データ内の行の総数です。 |
分析情報の値
Value 配列の要素には、次の値が含まれます。
| 値 | 種類 | 内容 |
|---|---|---|
| applicationId | string | 分析情報データを取得したデスクトップ アプリケーションの製品 ID です。 |
| insightDate | string | 特定のメトリックの変化を特定した日付です。 この日付は、前の週と比較してメトリックの大幅な増減が検出された週の終わりを表します。 |
| dataType | string | この分析情報によって知らされる一般的な分析領域を指定する文字列です。 現在、このメソッドでは health のみがサポートされています。 |
| insightDetail | 配列 | 現在の分析情報の詳細を表す 1 つ以上の InsightDetail 値です。 |
InsightDetail 値
| 値 | 種類 | 説明 |
|---|---|---|
| FactName | string | 現在の分析情報または現在のディメンションによって記述されているメトリックを示す文字列です。 現在、このメソッドでは値 HitCount のみがサポートされています。 |
| SubDimensions | 配列 | 分析情報の 1 つのメトリックを記述する 1 つ以上のオブジェクトです。 |
| PercentChange | string | 顧客ベース全体でメトリックが変化した割合です。 |
| DimensionName | string | 現在のディメンションに記述されているメトリックの名前です。 たとえば、EventType、Market、DeviceType、PackageVersion などです。 |
| DimensionValue | string | 現在のディメンションに記述されているメトリックの値です。 たとえば、DimensionName が EventType の場合、DimensionValue は crash や hang などになります。 |
| FactValue | string | 分析情報が検出された日付のメトリックの絶対値です。 |
| 方向 | string | 変化の方向です (Positive または Negative)。 |
| 日 | string | 現在の分析情報または現在のディメンションに関連する変化が特定された日付です。 |
応答の例
この要求の JSON 返信の本文の例を次に示します。
{
"Value": [
{
"applicationId": "9NBLGGGZ5QDR",
"insightDate": "2018-06-03T00:00:00",
"dataType": "health",
"insightDetail": [
{
"FactName": "HitCount",
"SubDimensions": [
{
"FactName:": "HitCount",
"PercentChange": "21",
"DimensionValue:": "DE",
"FactValue": "109",
"Direction": "Positive",
"Date": "6/3/2018 12:00:00 AM",
"DimensionName": "Market"
}
],
"DimensionValue": "crash",
"Date": "6/3/2018 12:00:00 AM",
"DimensionName": "EventType"
},
{
"FactName": "HitCount",
"SubDimensions": [
{
"FactName:": "HitCount",
"PercentChange": "71",
"DimensionValue:": "JP",
"FactValue": "112",
"Direction": "Positive",
"Date": "6/3/2018 12:00:00 AM",
"DimensionName": "Market"
}
],
"DimensionValue": "hang",
"Date": "6/3/2018 12:00:00 AM",
"DimensionName": "EventType"
},
],
"insightId": "9CY0F3VBT1AS942AFQaeyO0k2zUKfyOhrOHc0036Iwc="
}
],
"@nextLink": null,
"TotalCount": 2
}