デスクトップ アプリケーションのエラー報告データの取得

  • [アーティクル]

Microsoft Store 分析 API のこのメソッドを使用すると、Windows デスクトップ アプリケーション プログラムに追加したデスクトップ アプリケーションに関する集計のエラー報告データを取得できます。 このメソッドで取得できるのは、過去 30 日以内に発生したエラーのみです。 この情報は、パートナー センターにあるデスクトップ アプリケーションの状態レポートでも確認できます。

前提条件

このメソッドを使うには、最初に次の作業を行う必要があります。

  • Microsoft Store 分析 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。
  • このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。 アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れたら新しいトークンを取得できます。

要求

要求の構文

認証方法 要求 URI
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failurehits

要求ヘッダー

Header 型 説明
承認 string 必須。 Bearer<トークン> という形式の Azure AD アクセス トークン。

要求パラメーター

パラメーター Type 内容 必須
applicationId string エラー報告データを取得するデスクトップ アプリケーションの製品 ID です。 デスクトップ アプリケーションの製品 ID を取得するには、パートナー センターでデスクトップ アプリケーションの分析レポートのいずれか (状態レポートなど) を開き、URL から製品 ID を取得します。 はい
startDate 日付 エラー報告データを取得する期間の開始日です。mm/dd/yyyy の形式で指定します。 既定値は現在の日付です。

注: このメソッドで取得できるのは、過去 30 日以内に発生したエラーのみです。		 いいえ
endDate 日付 エラー報告データを取得する期間の終了日です。mm/dd/yyyy の形式で指定します。 既定値は現在の日付です。 いいえ
top int 要求で返すデータの行数です。 最大値および指定しない場合の既定値は 10000 です。 クエリにこれを上回る行がある場合は、応答本文に次リンクが含まれ、そのリンクを使ってデータの次のページを要求できます。 いいえ
skip int クエリでスキップする行数です。 大きなデータ セットを操作するには、このパラメーターを使用します。 たとえば、top=10000 と skip=0 を指定すると、データの最初の 10,000 行が取得され、top=10000 と skip=10000 を指定すると、データの次の 10,000 行が取得されます。 No
filter string 応答内の行をフィルター処理する 1 つまたは複数のステートメントです。 各ステートメントでは応答本文のフィールド名と値が eq 演算子または ne 演算子で関連付けられ、ステートメントは and または or を使用して組み合わせることができます。 filter パラメーターでは、文字列値を単一引用符で囲む必要があります。 応答本文から次のフィールドを指定できます。

  • fileName
  • applicationVersion
  • failureName
  • failureHash
  • symbol
  • osVersion
  • osBuild
  • osRelease
  • eventType
  • market
  • deviceType
  • productName
  • date
 いいえ
aggregationLevel string 集計データを取得する時間範囲を指定します。 次のいずれかの文字列を指定できます。day、week、または month。 指定しない場合、既定値は day です。 week または month を指定した場合、failureName と failureHash の値は 1000 バケットに制限されます。

 いいえ
orderby string 結果データ値の順序を指定するステートメントです。 構文は orderby=field [order],field [order],... です。field パラメーターは次のいずれかの文字列になります。
  • fileName
  • applicationVersion
  • failureName
  • failureHash
  • symbol
  • osVersion
  • osBuild
  • osRelease
  • eventType
  • market
  • deviceType
  • productName
  • date
order パラメーターは省略可能であり、asc または desc を指定して、各フィールドを昇順または降順にすることができます。 既定値は asc です。

orderby 文字列の例: orderby=date,market

 No
groupby string 指定したフィールドのみにデータ集計を適用するステートメントです。 次のフィールドを指定できます。
  • failureName
  • failureHash
  • symbol
  • osVersion
  • eventType
  • market
  • deviceType

返されるデータ行には、groupby パラメーターで指定されたフィールドと、次のものが含まれます。

  • date
  • applicationId
  • applicationName
  • eventCount

groupby パラメーターは、aggregationLevel パラメーターと同時に使用できます。 例: &groupby=failureName,market&aggregationLevel=week

 いいえ

要求の例

エラー報告データを取得するための要求の例を、いくつか次に示します。 applicationId の値は、デスクトップ アプリケーションの製品 ID に置き換えてください。

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failurehits?applicationId=10238467886765136388&startDate=1/1/2018&endDate=2/1/2018&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failurehits?applicationId=10238467886765136388&startDate=8/1/2017&endDate=8/31/2017&skip=0&filter=market eq 'US' and deviceType eq 'PC' HTTP/1.1
Authorization: Bearer <your access token>

回答

応答本文

値 種類 説明
値 配列 集計のエラー報告データを含むオブジェクトの配列です。 各オブジェクトのデータについての詳細は、後述の「エラー値」セクションを参照してください。
@nextLink string データの追加ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。 たとえば、要求の top パラメーターを 10000 に設定した場合、クエリに適合するエラーが 10000 行を超えると、この値が返されます。
TotalCount 整数 (integer) クエリの結果データ内の行の総数です。

エラー値

Value 配列の要素には、次の値が含まれます。

値 種類 説明
date string エラー データの期間の最初の日付です。yyyy-mm-dd の形式で指定します。 要求で日付が指定された場合、この値はその日付になります。 要求で長い期間が指定された場合、この値はその期間の最初の日付になります。 aggregationLevel の値を hour として指定する要求の場合、この値には hh:mm:ss 形式の時刻値も含まれます。
applicationId string エラー データを取得したデスクトップ アプリケーションのエラー ID です。
productName string 関連付けられている実行可能ファイルのメタデータから派生した、デスクトップ アプリケーションの表示名です。
appName string TBD
fileName string デスクトップ アプリケーションの実行可能ファイル名です。
failureName string エラーの名前です。1 つ以上の問題クラス、例外/バグチェックコード、エラーが発生したイメージの名前、および関連する関数名の 4 つの部分で構成されます。
failureHash string エラーの一意の識別子です。
symbol string このエラーに割り当てられたシンボルです。
osBuild string エラーが発生した OS の 4 つの部分から成るビルド番号です。
osVersion string デスクトップ アプリケーションがインストールされている OS のバージョンを示す、以下のいずれかの文字列です。

  • Windows 7
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Windows Server 2016
  • Windows Server 1709
  • 不明
osRelease string エラーが発生している OS のリリースまたはフライティング リングを (OS バージョン内のサブグループとして) 示す、以下のいずれかの文字列です。

Windows 11 の場合: Version 2110

Windows 10 の場合:

  • Version 1507
  • Version 1511
  • Version 1607
  • Version 1703
  • バージョン 1709
  • Version 1803
  • Release Preview
  • Insider Fast
  • Insider Slow

Windows Server 1709 の場合:

  • RTM

Windows Server 2016 の場合:

  • Version 1607

Windows 8.1 の場合:

  • Update 1

Windows 7 の場合:

  • Service Pack 1

OS リリースまたはフライティング リングが不明な場合、このフィールドの値は [Unknown] (不明) になります。
eventType string エラー イベントの種類を示す、次のいずれかの文字列です。
  • crash
  • hang
  • memory
  • jse
market string デバイス市場の ISO 3166 の国コードです。
deviceType string エラーが発生したデバイスの種類を指定する、以下のいずれかの文字列です。

  • PC
  • [サーバー]
  • タブレット PC
  • 不明
applicationVersion string エラーが発生したアプリケーション実行可能ファイルのバージョンです。
eventCount 数値 指定された集計レベルでの、このエラーに起因するイベント数です。

応答の例

この要求の JSON 返信の本文の例を次に示します。

{
  "Value": [
    {
      "date": "2018-02-01",
      "applicationId": "10238467886765136388",
      "productName": "Contoso Demo",
      "appName": "Contoso Demo",
      "fileName": "contosodemo.exe",
      "failureName": "SVCHOSTGROUP_localservice_IN_PAGE_ERROR_c0000006_hardware_disk!Unknown",
      "failureHash": "11242ef3-ebd8-d525-838d-b5497b225695",
      "symbol": "hardware_disk!Unknown",
      "osBuild": "10.0.15063.850",
      "osVersion": "Windows 10",
      "osRelease": "Version 1703",
      "eventType": "crash",
      "market": "US",
      "deviceType": "PC",
      "applicationVersion": "2.2.2.0",
      "eventCount": 0.0012422360248447205
    }
  ],
  "@nextLink": "desktop/failurehits?applicationId=10238467886765136388&aggregationLevel=week&startDate=2018/02/01&endDate2018/02/08&top=1&skip=1",
  "TotalCount": 21
}