アプリのエラーに関する詳細情報の取得
アプリの特定のエラーに関する詳細データを JSON 形式で取得するには、Microsoft Store 分析 API の以下のメソッドを使います。 このメソッドで取得できるのは、過去 30 日以内に発生したエラーの詳細のみです。 詳細なエラー データは、パートナー センターの状態レポートの [エラー] セクションでも確認できます。
このメソッドを使うには、その前にまず「エラー報告データの取得」のメソッドを使って、詳細情報を取得するエラーの ID を取得する必要があります。
前提条件
このメソッドを使うには、最初に次の作業を行う必要があります。
- Microsoft Store 分析 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。
- このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。 アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れたら新しいトークンを取得できます。
- 詳細情報を取得するエラーの ID を取得します。 この ID を取得するには、「エラー報告データの取得」のメソッドを使い、そのメソッドの応答本文で failureHash の値を使います。
要求
要求の構文
| 認証方法 | 要求 URI |
|---|---|
| GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/failuredetails |
要求ヘッダー
| Header | 種類 | 説明 |
|---|---|---|
| 承認 | string | 必須。 Bearer<トークン> という形式の Azure AD アクセス トークン。 |
要求パラメーター
| パラメーター | 種類 | 説明 | 必須 |
|---|---|---|---|
| applicationId | string | 詳細なエラー データを取得するアプリのストア ID です。 ストア ID は、パートナー センターのアプリ ID ページで確認できます。 ストア ID は、たとえば 9WZDNCRFJ3Q8 のような文字列です。 | はい |
| failureHash | string | 取得する詳細情報の対象となるエラーの一意の ID です。 目的のエラーについてこの ID を取得するには、「エラー報告データの取得」のメソッドを使い、そのメソッドの応答本文で failureHash の値を使います。 | はい |
| startDate | 日付 | 取得する詳細なエラー データの日付範囲の開始日です。 既定値は、現在の日付の 30 日前です。注: このメソッドで取得できるのは、過去 30 日以内に発生したエラーの詳細のみです。 | いいえ |
| endDate | 日付 | 取得する詳細なエラー データの日付範囲の終了日です。 既定値は現在の日付です。 | いいえ |
| top | int | 要求で返すデータの行数です。 最大値および指定しない場合の既定値は 10000 です。 クエリにこれを上回る行がある場合は、応答本文に次リンクが含まれ、そのリンクを使ってデータの次のページを要求できます。 | いいえ |
| skip | int | クエリでスキップする行数です。 大きなデータ セットを操作するには、このパラメーターを使用します。 たとえば、top=10 と skip=0 を指定すると、データの最初の 10 行が取得され、top=10 と skip=10 を指定すると、データの次の 10 行が取得されます。 | No |
| filter | string | 応答内の行をフィルター処理する 1 つまたは複数のステートメントです。 各ステートメントには、応答本文からのフィールド名、および eq 演算子または ne 演算子と関連付けられる値が含まれており、and や or を使用してステートメントを組み合わせることができます。 filter パラメーターでは、文字列値を単一引用符で囲む必要があります。 応答本文から次のフィールドを指定することができます。
|
No |
| 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/failuredetails?applicationId=9NBLGGGZ5QDR&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/failuredetails?applicationId=9NBLGGGZ5QDR&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 'Windows.Desktop' HTTP/1.1
Authorization: Bearer <your access token>
[応答]
応答本文
| 値 | 種類 | 説明 |
|---|---|---|
| 値 | array | 詳細なエラー データが含まれているオブジェクトの配列です。 各オブジェクトのデータについて詳しくは、次の「エラーの詳細情報の値」セクションをご覧ください。 |
| @nextLink | string | データの追加ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。 たとえば、要求の top パラメーターを 10 に設定した場合、クエリに適合するエラーが 10 行を超えると、この値が返されます。 |
| TotalCount | 整数 (integer) | クエリの結果データ内の行の総数です。 |
エラーの詳細情報の値
Value 配列の要素には、次の値が含まれます。
| 値 | 種類 | 説明 |
|---|---|---|
| applicationId | string | 詳細なエラー データを取得したアプリの Store ID です。 |
| failureHash | string | エラーの一意の識別子です。 |
| failureName | string | 4 つの部分から成るエラーの名前です。問題が発生した 1 つ以上のクラス、例外/バグ チェック コード、障害が発生したイメージの名前、関連する関数の名前で構成されます。 |
| 日付 | string | エラー データの日付範囲の最初の日付です。 要求に日付を指定した場合、この値はその日付になります。 要求に週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。 |
| cabId | string | このエラーに関連付けられている CAB ファイルの一意の ID です。 |
| cabExpirationTime | string | CAB ファイルの有効期限が切れ、ダウンロードできなくなる日付と時刻 (ISO 8601形式) です。 |
| market | string | デバイス市場の ISO 3166 国コードです。 |
| osBuild | string | エラーが発生した OS のビルド番号です。 |
| packageVersion | string | このエラーに関連付けられているアプリ パッケージのバージョンです。 |
| deviceModel | string | エラーが発生したときにアプリを実行していたデバイスのモデルを指定する文字列です。 |
| osVersion | string | エラーが発生した OS のバージョンを示す、以下のいずれかの文字列です。
|
| osRelease | string | エラーが発生した OS リリースまたはフライティング リングを (OS バージョン内のサブグループとして) 指定する、以下のいずれかの文字列です。 Windows 11の場合: バージョン 2110 Windows 10 の場合:
Windows Server 1709 の場合:
Windows Server 2016 の場合:
Windows 8.1 の場合:
Windows 7 の場合:
OS リリースまたはフライティング リングが不明な場合、このフィールドは値 Unknown になります。 |
| deviceType | string | エラーが発生したときにアプリを実行していたデバイスの種類を指定する、以下のいずれかの文字列です。
|
| cabDownloadable | ブール値 | このユーザーが CAB ファイルをダウンロードできるかどうかを示します。 |
注意
このメソッドで取得できるのは、過去 30 日以内に発生したエラーの詳細のみです。
要求と応答の例
次のコード スニペットは、これらの要求の要求と JSON 応答本文の例を示しています。
要求のサンプル
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/failuredetails?applicationId=9NBLGGGZ5QDR&failureHash=012345-5dbc9-b12f-c124-9d9810f05d8b&startDate=2022-06-30&endDate=2022-07-28&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>
応答のサンプル
{
"Value": [
{
"date": "2022-07-12 00:00:00",
"cabExpirationTime": "2022-08-16 01:37:00",
"cabDownloadable": false,
"applicationId": "9NBLGGGZ5QDR",
"failureHash": "012345-5dbc9-b12f-c124-9d9810f05d8b",
"failureName": "MOAPPLICATION_HANG_cfffffff_Microsoft.Contoso!HANG_QUIESCE",
"cabId": "1180087848576586304",
"market": "MX",
"osBuild": "10.0.19043",
"packageVersion": "2.5.2.34894",
"deviceModel": "Dell Inc.-Inspiron 15-3567",
"osVersion": "Windows 10",
"osRelease": "Version 21H1",
"osArchitecture": "x64",
"deviceType": "PC",
"cpuManufacturer": "Intel",
"cpuFamilyName": "Core i5",
"cpuName": "Intel Core i5-7200U CPU @ 2.50GHz",
"praid": "app",
"flightRing": "",
"sandboxId": "retail"
},
{
"date": "2022-07-13 00:00:00",
"cabExpirationTime": "2022-08-17 13:35:53",
"cabDownloadable": true,
"applicationId": "9NBLGGGZ5QDR",
"failureHash": "012345-5dbc9-b12f-c124-9d9810f05d8b",
"failureName": "MOAPPLICATION_HANG_cfffffff_Microsoft.Contoso!HANG_QUIESCE",
"cabId": "2058585545558157474",
"market": "RO",
"osBuild": "10.0.22622",
"packageVersion": "2.5.2.34894",
"deviceModel": "Dell Inc.-Vostro 5502",
"osVersion": "Windows 11",
"osRelease": "External",
"osArchitecture": "x64",
"deviceType": "PC",
"cpuManufacturer": "Intel",
"cpuFamilyName": "Core i5",
"cpuName": "11th Gen Intel Core i5-1135G7 @ 2.40GHz",
"praid": "app",
"flightRing": "external",
"sandboxId": "retail"
},
{
"date": "2022-07-14 00:00:00",
"cabExpirationTime": "2022-08-18 07:27:06",
"cabDownloadable": false,
"applicationId": "9NBLGGGZ5QDR",
"failureHash": "012345-5dbc9-b12f-c124-9d9810f05d8b",
"failureName": "MOAPPLICATION_HANG_cfffffff_Microsoft.Contoso!HANG_QUIESCE",
"cabId": "1940204079766793391",
"market": "IN",
"osBuild": "10.0.19044",
"packageVersion": "2.5.2.34894",
"deviceModel": "Generic Desktop",
"osVersion": "Windows 10",
"osRelease": "Version 21H2",
"osArchitecture": "x64",
"deviceType": "PC",
"cpuManufacturer": "Intel",
"cpuFamilyName": "Pentium",
"cpuName": "Intel Pentium CPU G630 @ 2.70GHz",
"praid": "app",
"flightRing": "",
"sandboxId": "retail"
},
{
"date": "2022-07-17 00:00:00",
"cabExpirationTime": "2022-08-21 10:04:16",
"cabDownloadable": true,
"applicationId": "9NBLGGGZ5QDR",
"failureHash": "012345-5dbc9-b12f-c124-9d9810f05d8b",
"failureName": "MOAPPLICATION_HANG_cfffffff_Microsoft.Contoso!HANG_QUIESCE",
"cabId": "1197051093472061859",
"market": "ES",
"osBuild": "10.0.22621",
"packageVersion": "2.5.2.34894",
"deviceModel": "Microsoft Corporation-Surface Pro 3",
"osVersion": "Windows 11",
"osRelease": "External",
"osArchitecture": "x64",
"deviceType": "PC",
"cpuManufacturer": "Intel",
"cpuFamilyName": "Core i7",
"cpuName": "Intel Core i7-4650U CPU @ 1.70GHz",
"praid": "app",
"flightRing": "external",
"sandboxId": "retail"
},
{
"date": "2022-07-20 00:00:00",
"cabExpirationTime": "2022-08-24 12:40:05",
"cabDownloadable": false,
"applicationId": "9NBLGGGZ5QDR",
"failureHash": "012345-5dbc9-b12f-c124-9d9810f05d8b",
"failureName": "MOAPPLICATION_HANG_cfffffff_Microsoft.Contoso!HANG_QUIESCE",
"cabId": "1332886311327579782",
"market": "RU",
"osBuild": "6.3.9600",
"packageVersion": "2.5.2.34894",
"deviceModel": "ASUSTeK COMPUTER INC.-K75VJ",
"osVersion": "Windows 8.1",
"osRelease": "RTM",
"osArchitecture": "x64",
"deviceType": "PC",
"cpuManufacturer": "Intel",
"cpuFamilyName": "Core i7",
"cpuName": "Intel Core i7-3630QM CPU @ 2.40GHz",
"praid": "app",
"flightRing": "",
"sandboxId": ""
}
],
"TotalCount": 5
}
関連トピック
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示