デスクトップ アプリケーションのエラーに関する詳細情報の取得Get details for an error in your desktop application

アプリの特定のエラーに関する詳細データを JSON 形式で取得するには、Microsoft Store 分析 API の以下のメソッドを使います。Use this method in the Microsoft Store analytics API to get detailed data for a specific error for your app in JSON format. このメソッドで取得できるのは、過去 30 日以内に発生したエラーの詳細のみです。This method can only retrieve details for errors that occurred in the last 30 days. 詳細なエラー データも記載されて、正常性レポートパートナー センターでのデスクトップ アプリケーションです。Detailed error data is also available in the Health report for desktop applications in Partner Center.

このメソッドを使うには、その前にまず「エラー報告データの取得」のメソッドを使って、詳細情報を取得するエラーの ID を取得する必要があります。Before you can use this method, you must first use the get error reporting data method to retrieve the ID of the error for which you want to get detailed info.

前提条件Prerequisites

このメソッドを使うには、最初に次の作業を行う必要があります。To use this method, you need to first do the following:

  • Microsoft Store 分析 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
  • このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。Obtain an Azure AD access token to use in the request header for this method. アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。After you obtain an access token, you have 60 minutes to use it before it expires. トークンの有効期限が切れたら新しいトークンを取得できます。After the token expires, you can obtain a new one.
  • 詳細情報を取得するエラーの ID を取得します。Get the ID of the error for which you want to get detailed info. この ID を取得するには、「エラー報告データの取得」のメソッドを使い、そのメソッドの応答本文で failureHash の値を使います。To get this ID, use the get error reporting data method and use the failureHash value in the response body of that method.

要求Request

要求の構文Request syntax

メソッドMethod 要求 URIRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failuredetails

要求ヘッダーRequest header

HeaderHeader 種類Type 説明Description
AuthorizationAuthorization stringstring 必須。Required. Bearer <トークン> という形式の Azure AD アクセス トークン。The Azure AD access token in the form Bearer <token>.

要求パラメーターRequest parameters

パラメーターParameter 種類Type 説明Description 必須Required
applicationIdapplicationId stringstring エラーの詳細を取得するデスクトップ アプリケーションの製品 ID です。The product ID of the desktop application for which you want to retrieve error details. デスクトップ アプリケーションの製品 ID を取得するには、いずれかを開くanalytics は、パートナー センターでデスクトップ アプリケーションのレポート(など、正常性レポート) し、URL から、製品 ID を取得します。To get the product ID of a desktop application, open any analytics report for your desktop application in Partner Center (such as the Health report) and retrieve the product ID from the URL. Yes
failureHashfailureHash stringstring 取得する詳細情報の対象となるエラーの一意の ID です。The unique ID of the error for which you want to get detailed info. 目的のエラーについてこの ID を取得するには、「エラー報告データの取得」のメソッドを使い、そのメソッドの応答本文で failureHash の値を使います。To get this value for the error you are interested in, use the get error reporting data method and use the failureHash value in the response body of that method. Yes
startDatestartDate datedate 取得する詳細なエラー データの日付範囲の開始日です。The start date in the date range of detailed error data to retrieve. 既定値は、現在の日付の 30 日前です。The default is 30 days before the current date.

注:   このメソッドは過去 30 日以内に発生したエラーの詳細のみを取得します。Note:  This method can only retrieve details for errors that occurred in the last 30 days.

XNo
endDateendDate datedate 取得する詳細なエラー データの日付範囲の終了日です。The end date in the date range of detailed error data to retrieve. 既定値は現在の日付です。The default is the current date. XNo
toptop intint 要求で返すデータの行数です。The number of rows of data to return in the request. 最大値および指定しない場合の既定値は 10000 です。The maximum value and the default value if not specified is 10000. クエリにこれを上回る行がある場合は、応答本文に次リンクが含まれ、そのリンクを使ってデータの次のページを要求できます。If there are more rows in the query, the response body includes a next link that you can use to request the next page of data. XNo
skipskip intint クエリでスキップする行数です。The number of rows to skip in the query. 大きなデータ セットを操作するには、このパラメーターを使用します。Use this parameter to page through large data sets. たとえば、top=10 と skip=0 を指定すると、データの最初の 10 行が取得され、top=10 と skip=10 を指定すると、データの次の 10 行が取得されます。For example, top=10 and skip=0 retrieves the first 10 rows of data, top=10 and skip=10 retrieves the next 10 rows of data, and so on. XNo
filterfilter stringstring 応答内の行をフィルター処理する 1 つまたは複数のステートメントです。One or more statements that filter the rows in the response. 各ステートメントには、応答本文からのフィールド名、および eq 演算子または ne 演算子と関連付けられる値が含まれており、andor を使用してステートメントを組み合わせることができます。Each statement contains a field name from the response body and value that are associated with the eq or ne operators, and statements can be combined using and or or. filter パラメーターでは、文字列値を単一引用符で囲む必要があります。String values must be surrounded by single quotes in the filter parameter. 応答本文から次のフィールドを指定することができます。You can specify the following fields from the response body:

  • marketmarket
  • datedate
  • cabIdHashcabIdHash
  • cabExpirationTimecabExpirationTime
  • deviceTypedeviceType
  • deviceModeldeviceModel
  • osVersionosVersion
  • osReleaseosRelease
  • applicationVersionapplicationVersion
  • osBuildosBuild
  • fileNamefileName
XNo
orderbyorderby stringstring 結果データ値の順序を指定するステートメントです。A statement that orders the result data values. 構文は orderby=field [order],field [order],... です。field パラメーターには、次のいずれかの文字列を指定できます。The syntax is orderby=field [order],field [order],.... The field parameter can be one of the following strings:
  • marketmarket
  • datedate
  • cabIdHashcabIdHash
  • cabExpirationTimecabExpirationTime
  • deviceTypedeviceType
  • deviceModeldeviceModel
  • osVersionosVersion
  • osReleaseosRelease
  • applicationVersionapplicationVersion
  • osBuildosBuild
  • fileNamefileName

order パラメーターは省略可能であり、asc または desc を指定して、各フィールドを昇順または降順にすることができます。The order parameter is optional, and can be asc or desc to specify ascending or descending order for each field. 既定値は asc です。The default is asc.

orderby 文字列の例: orderby=date,marketHere is an example orderby string: orderby=date,market

XNo

要求の例Request example

詳細なエラー データを取得するための要求の例を次に示します。The following examples demonstrate several requests for getting detailed error data. applicationId の値は、デスクトップ アプリケーションの製品 ID に置き換えてください。Replace the applicationId value with the product ID for your desktop application.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failuredetails?applicationId=10238467886765136388&failureHash=012e33e3-dbc9-b12f-c124-9d9810f05d8b&startDate=2016-11-05&endDate=2016-11-06&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failuredetails?applicationId=10238467886765136388&failureHash=012e33e3-dbc9-b12f-c124-9d9810f05d8b&startDate=2016-11-05&endDate=2016-11-06&top=10&skip=0&filter=market eq 'US' and deviceType eq 'PC' HTTP/1.1
Authorization: Bearer <your access token>

応答Response

応答本文Response body

ValueValue 種類Type 説明Description
ValueValue arrayarray 詳細なエラー データが含まれているオブジェクトの配列です。An array of objects that contain detailed error data. 各オブジェクトのデータについて詳しくは、次の「エラーの詳細情報の値」セクションをご覧ください。For more information about the data in each object, see the error detail values section below.
@nextLink stringstring データの追加ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。If there are additional pages of data, this string contains a URI that you can use to request the next page of data. たとえば、要求の top パラメーターを 10 に設定した場合、クエリに適合するエラーが 10 行を超えると、この値が返されます。For example, this value is returned if the top parameter of the request is set to 10 but there are more than 10 rows of errors for the query.
TotalCountTotalCount 整数integer クエリの結果データ内の行の総数です。The total number of rows in the data result for the query.

エラーの詳細情報の値Error detail values

Value 配列の要素には、次の値が含まれます。Elements in the Value array contain the following values.

ValueValue 種類Type 説明Description
applicationIdapplicationId stringstring エラーの詳細を取得したデスクトップ アプリケーションの製品 ID です。The product ID of the desktop application for which you retrieved error details.
failureHashfailureHash stringstring エラーの一意の識別子です。The unique identifier for the error.
failureNamefailureName stringstring 4 つの部分から成るエラーの名前です。問題が発生した 1 つ以上のクラス、例外/バグ チェック コード、障害が発生したイメージの名前、関連する関数の名前で構成されます。The name of the failure, which is made up of four parts: one or more problem classes, an exception/bug check code, the name of the image where the failure occurred, and the associated function name.
datedate stringstring エラー データの日付範囲の最初の日付です。The first date in the date range for the error data. 要求に日付を指定した場合、この値はその日付になります。If the request specified a single day, this value is that date. 要求に週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。If the request specified a week, month, or other date range, this value is the first date in that date range.
cabIdHashcabIdHash stringstring このエラーに関連付けられている CAB ファイルの一意の ID ハッシュです。The unique ID hash of the CAB file that is associated with this error.
cabExpirationTimecabExpirationTime stringstring CAB ファイルの有効期限が切れ、ダウンロードできなくなる日付と時刻 (ISO 8601形式) です。The date and time when the CAB file is expired and can no longer be downloaded, in ISO 8601 format.
marketmarket stringstring デバイス市場の ISO 3166 国コードです。The ISO 3166 country code of the device market.
osBuildosBuild stringstring エラーが発生した OS のビルド番号です。The build number of the OS on which the error occurred.
applicationVersionapplicationVersion stringstring エラーが発生したアプリケーションの実行可能ファイルのバージョンです。The version of the application executable in which the error occurred.
deviceModeldeviceModel stringstring エラーが発生したときにアプリを実行していたデバイスのモデルを指定する文字列です。A string that specifies the model of the device on which the app was running when the error occurred.
osVersionosVersion stringstring デスクトップ アプリケーションがインストールされている OS のバージョンを示す、以下のいずれかの文字列です。One of the following strings that specifies the OS version on which the desktop application is installed:

  • Windows 7Windows 7
  • Windows 8.1Windows 8.1
  • Windows 10Windows 10
  • Windows Server 2016Windows Server 2016
  • Windows Server 1709Windows Server 1709
  • UnknownUnknown
osReleaseosRelease stringstring エラーが発生した OS リリースまたはフライティング リングを (OS バージョン内のサブグループとして) 指定する、以下のいずれかの文字列です。One of the following strings that specifies the OS release or flighting ring (as a subpopulation within OS version) on which the error occurred.

Windows 10 の場合:For Windows 10:

  • バージョン 1507Version 1507
  • バージョン 1511Version 1511
  • バージョン 1607Version 1607
  • バージョン 1703Version 1703
  • バージョン 1709Version 1709
  • バージョン 1803Version 1803
  • Release PreviewRelease Preview
  • Insider FastInsider Fast
  • 低速 insiderInsider Slow

Windows Server 1709 の場合:For Windows Server 1709:

  • RTMRTM

Windows Server 2016 の場合:For Windows Server 2016:

  • バージョン 1607Version 1607

Windows 8.1 の場合:For Windows 8.1:

  • 更新プログラム 1Update 1

Windows 7 の場合:For Windows 7:

  • Service Pack 1Service Pack 1

OS リリースまたはフライティング リングが不明な場合、このフィールドは値 Unknown になります。If the OS release or flighting ring is unknown, this field has the value Unknown.

deviceTypedeviceType stringstring エラーが発生したデバイスの種類を示す、以下のいずれかの文字列です。One of the following strings that indicates the type of device on which the error occurred:

  • PCPC
  • [サーバー]Server
  • UnknownUnknown
cabDownloadablecabDownloadable ブール値Boolean このユーザーが CAB ファイルをダウンロードできるかどうかを示します。Indicates whether the CAB file is downloadable for this user.
fileNamefileName stringstring エラーの詳細を取得したデスクトップ アプリケーションの実行可能ファイルの名前です。The name of the executable file for the desktop application for which you retrieved error details.

応答の例Response example

この要求の JSON 返信の本文の例を次に示します。The following example demonstrates an example JSON response body for this request.

{
  "Value": [
    {
      "applicationId": "10238467886765136388",
      "failureHash": "012345-5dbc9-b12f-c124-9d9810f05d8b",
      "failureName": "NULL_CLASS_PTR_WRITE_c0000005_contoso.exe!unknown_error_in_process",
      "date": "2018-01-28 23:55:29",
      "cabIdHash": "54ffb83a-e159-41d2-8158-f36f306cc01e",
      "cabExpirationTime": "2018-02-27 23:55:29",
      "market": "US",
      "osBuild": "10.0.10240",
      "applicationVersion": "2.2.2.0",
      "deviceModel": "Contoso All-in-one",
      "osVersion": "Windows 10",
      "osRelease": "Version 1703",
      "deviceType": "PC",
      "cabDownloadable": false,
      "fileName": "contosodemo.exe"
    }
  ],
  "@nextLink": null,
  "TotalCount": 1
}