デスクトップ アプリケーションのエラーに関する詳細情報の取得
アプリの特定のエラーの詳細なデータを JSON 形式で取得するには、Microsoft Store 分析 API の次のメソッドを使用します。 このメソッドは、過去 30 日間に発生したエラーの詳細のみを取得できます。 詳細なエラー データは、パートナー センターにあるデスクトップ アプリケーションの状態レポートでも確認できます。
このメソッドを使用するには、まず、 get エラー報告データ メソッドを使用して、詳細情報を取得するエラーの ID を取得する必要があります。
前提条件
このメソッドを使うには、最初に次の作業を行う必要があります。
- Microsoft Store 分析 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。
- このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。 アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れたら新しいトークンを取得できます。
- 詳細情報を取得するエラーの ID を取得します。 この ID を取得するには、 get エラー報告データ メソッドを使用し、そのメソッドの応答本文で failureHash 値を使用します。
要求
要求の構文
| 認証方法 | 要求 URI |
|---|---|
| GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failuredetails |
要求ヘッダー
| Header | 型 | 説明 |
|---|---|---|
| 承認 | string | 必須。 Bearer<トークン> という形式の Azure AD アクセス トークン。 |
要求パラメーター
| パラメーター | 型 | 内容 | 必須 |
|---|---|---|---|
| applicationId | string | エラーの詳細を取得するデスクトップ アプリケーションの製品 ID。 デスクトップ アプリケーションの製品 ID を取得するには、パートナー センターでデスクトップ アプリケーションの分析レポートのいずれか (状態レポートなど) を開き、URL から製品 ID を取得します。 | はい |
| failureHash | string | 詳細情報を取得するエラーの一意の ID。 関心のあるエラーのこの値を取得するには、 get エラー報告データ メソッドを使用し、そのメソッドの応答本文で failureHash 値を使用します。 | はい |
| startDate | 日付 | 取得する詳細なエラー データの日付範囲の開始日。 既定値は、現在の日付の 30 日前です。注: このメソッドで取得できるのは、過去 30 日以内に発生したエラーの詳細のみです。 | いいえ |
| endDate | 日付 | 取得する詳細なエラー データの日付範囲の終了日。 既定値は現在の日付です。 | いいえ |
| top | int | 要求で返すデータの行数です。 最大値および指定しない場合の既定値は 10000 です。 クエリにこれを上回る行がある場合は、応答本文に次リンクが含まれ、そのリンクを使ってデータの次のページを要求できます。 | いいえ |
| skip | int | クエリでスキップする行数です。 大きなデータ セットを操作するには、このパラメーターを使用します。 たとえば、top=10 と skip=0 はデータの最初の 10 行を取得し、top=10 と skip=10 は次の 10 行のデータを取得します。 | いいえ |
| filter | string | 応答内の行をフィルター処理する 1 つまたは複数のステートメントです。 各ステートメントでは応答本文のフィールド名と値が eq 演算子または ne 演算子で関連付けられ、ステートメントは and または or を使用して組み合わせることができます。 filter パラメーターでは、文字列値を単一引用符で囲む必要があります。 応答本文から次のフィールドを指定できます。
|
いいえ |
| orderby | string | 結果データ値の順序を指定するステートメントです。 構文は orderby=field [order],field [order],... です。field パラメーターは次のいずれかの文字列になります。
order パラメーターは省略可能であり、asc または desc を指定して、各フィールドを昇順または降順にすることができます。 既定値は asc です。 orderby 文字列の例: orderby=date,market |
いいえ |
要求の例
次の例では、詳細なエラー データを取得するためのいくつかの要求を示します。 applicationId の値は、デスクトップ アプリケーションの製品 ID に置き換えてください。
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>
回答
応答本文
| 値 | 種類 | 説明 |
|---|---|---|
| 値 | 配列 | 詳細なエラー データを含むオブジェクトの配列。 各オブジェクトのデータの詳細については、以下の「 エラーの詳細値 」セクションを参照してください。 |
| @nextLink | string | データの追加ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。 たとえば、要求の top パラメーターを 10 に設定した場合、クエリに適合するエラーが 10 行を超えると、この値が返されます。 |
| TotalCount | 整数 (integer) | クエリの結果データ内の行の総数です。 |
エラーの詳細値
Value 配列の要素には、次の値が含まれます。
| 値 | 種類 | 内容 |
|---|---|---|
| applicationId | string | エラーの詳細を取得したデスクトップ アプリケーションの製品 ID。 |
| failureHash | string | エラーの一意の識別子です。 |
| failureName | string | エラーの名前です。1 つ以上の問題クラス、例外/バグチェックコード、エラーが発生したイメージの名前、および関連する関数名の 4 つの部分で構成されます。 |
| 日付 | string | エラー データの日付範囲の最初の日付。 要求に日付を指定した場合、この値はその日付になります。 要求に週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。 |
| cabIdHash | string | このエラーに関連付けられている CAB ファイルの一意の ID ハッシュ。 |
| cabExpirationTime | string | CAB ファイルの有効期限が切れ、ISO 8601 形式でダウンロードできなくなった日時。 |
| market | string | デバイス市場の ISO 3166 の国コードです。 |
| osBuild | string | エラーが発生した OS のビルド番号。 |
| applicationVersion | string | エラーが発生したアプリケーション実行可能ファイルのバージョンです。 |
| deviceModel | string | エラーが発生したときにアプリが実行されていたデバイスのモデルを指定する文字列。 |
| osVersion | string | デスクトップ アプリケーションがインストールされている OS のバージョンを指定する、以下のいずれかの文字列です。
|
| osRelease | string | エラーが発生している OS のリリースまたはフライティング リングを (OS バージョン内のサブグループとして) 示す、以下のいずれかの文字列です。 Windows 11 の場合: Version 2110 Windows 10 の場合:
Windows Server 1709 の場合:
Windows Server 2016 の場合:
Windows 8.1 の場合:
Windows 7 の場合:
OS リリースまたはフライティング リングが不明な場合、このフィールドの値は [Unknown] (不明) になります。 |
| deviceType | string | エラーが発生したデバイスの種類を示す次のいずれかの文字列。
|
| cabDownloadable | Boolean | このユーザーの CAB ファイルをダウンロードできるかどうかを示します。 |
| fileName | string | エラーの詳細を取得したデスクトップ アプリケーションの実行可能ファイルの名前。 |
応答の例
この要求の JSON 返信の本文の例を次に示します。
{
"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
}