アプリのエラーに関する詳細情報の取得

[アーティクル]
07/05/2024

アプリの特定のエラーの詳細なデータを 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/failuredetails`

要求ヘッダー

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

要求パラメーター

パラメーター	型	内容	必須
applicationId	string	詳細なエラーデータを取得するアプリのストア ID。ストア ID は、パートナーセンターのアプリ ID ページで確認できます。ストア ID は、たとえば 9WZDNCRFJ3Q8 のような文字列です。	はい
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 パラメーターでは、文字列値を単一引用符で囲む必要があります。応答本文から次のフィールドを指定できます。 market date cabId cabExpirationTime deviceType deviceModel osVersion osRelease packageVersion osBuild	いいえ
orderby	string	結果データ値の順序を指定するステートメントです。構文は orderby=field [order],field [order],... です。field パラメーターは次のいずれかの文字列になります。 market date cabId cabExpirationTime deviceType deviceModel osVersion osRelease packageVersion osBuild 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>

[応答]

応答本文

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

エラーの詳細値

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

値	種類	内容
applicationId	string	詳細なエラーデータを取得したアプリのストア ID。
failureHash	string	エラーの一意の識別子です。
failureName	string	エラーの名前です。1 つ以上の問題クラス、例外/バグチェックコード、エラーが発生したイメージの名前、および関連する関数名の 4 つの部分で構成されます。
日付	string	エラーデータの日付範囲の最初の日付。要求に日付を指定した場合、この値はその日付になります。要求に週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。
cabId	string	このエラーに関連付けられている CAB ファイルの一意の ID。
cabExpirationTime	string	CAB ファイルの有効期限が切れ、ISO 8601 形式でダウンロードできなくなった日時。
market	string	デバイス市場の ISO 3166 の国コードです。
osBuild	string	エラーが発生した OS のビルド番号。
packageVersion	string	このエラーに関連付けられているアプリパッケージのバージョンです。
deviceModel	string	エラーが発生したときにアプリが実行されていたデバイスのモデルを指定する文字列。
osVersion	string	エラーが発生した OS バージョンを示す次のいずれかの文字列。 Windows Phone 7.5 Windows Phone 8 Windows Phone 8.1 Windows Phone 10 Windows 8 Windows 8.1 Windows 10 Windows 11 不明
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] (不明) になります。
deviceType	string	エラーが発生したときにアプリが実行されていたデバイスの種類を指定する次のいずれかの文字列。 PC 電話 Console-Xbox One Console-Xbox Series X IoT Holographic 不明
cabDownloadable	Boolean	このユーザーの CAB ファイルをダウンロードできるかどうかを示します。

Note

このメソッドは、過去 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
}

次の方法で共有

アプリのエラーに関する詳細情報の取得

前提条件

要求

要求の構文

要求ヘッダー

要求パラメーター

要求の例

[応答]

応答本文

エラーの詳細値

要求と応答の例

サンプル要求

サンプル応答

フィードバック

その他のリソース

次の方法で共有

アプリのエラーに関する詳細情報の取得

前提条件

要求

要求の構文

要求ヘッダー

要求パラメーター

要求の例

[応答]

応答本文

エラーの詳細値

要求と応答の例

サンプル要求

サンプル応答

関連トピック

フィードバック

その他のリソース