次の方法で共有


アプリのエラー報告データの取得

Microsoft Store 分析 API でこのメソッドを使用すると、特定の期間および他のオプション フィルターを指定して、アプリに関する集計のエラー報告データを JSON 形式で取得できます。 このメソッドで取得できるのは、過去 30 日以内に発生したエラーのみです。 この情報は、パートナー センターの状態レポート[エラー] セクションでも確認できます。

エラーの詳細の取得スタック トレースの取得CAB ファイルのダウンロードのメソッドを使用して、追加のエラー情報を取得できます。

前提条件

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

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

要求

要求の構文

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

要求ヘッダー

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

要求パラメーター

パラメーター 内容 必須
applicationId string エラー報告データを取得するアプリのストア ID です。 ストア ID は、パートナー センターのアプリ ID ページで確認できます。 ストア ID は、たとえば 9WZDNCRFJ3Q8 のような文字列です。 はい
startDate 日付 取得するエラー報告データの期間の開始日です。 既定値は現在の日付です。 aggregationLeveldayweekmonth の場合、このパラメーターは mm/dd/yyyy の形式の日付で指定する必要があります。 aggregationLevelhour の場合、このパラメーターは mm/dd/yyyy の形式の日付で指定するか、yyyy-mm-dd hh:mm:ss の形式で日付と時刻を指定できます。

注: このメソッドで取得できるのは、過去 30 日以内に発生したエラーのみです。
いいえ
endDate 日付 取得するエラー報告データの期間の終了日です。 既定値は現在の日付です。 aggregationLeveldayweekmonth の場合、このパラメーターは mm/dd/yyyy の形式の日付で指定する必要があります。 aggregationLevelhour の場合、このパラメーターは mm/dd/yyyy の形式の日付で指定するか、yyyy-mm-dd hh:mm:ss の形式で日付と時刻を指定できます。 いいえ
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 パラメーターでは、文字列値を単一引用符で囲む必要があります。 応答本文から次のフィールドを指定できます。

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

注:hour を指定した場合は、過去 72 時間以内のエラー データしか取得できません。 72 時間より前のエラー データを取得するには、day または他の集計レベルのいずれかを指定します。
いいえ
orderby string 結果データ値の順序を指定するステートメントです。 構文は orderby=field [order],field [order],... です。field パラメーターは次のいずれかの文字列になります。
  • applicationName
  • failureName
  • failureHash
  • 記号
  • osVersion
  • osRelease
  • eventType
  • market
  • deviceType
  • packageName
  • packageVersion
  • date

order パラメーターは省略可能であり、asc または desc を指定して、各フィールドを昇順または降順にすることができます。 既定値は asc です。

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

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

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

  • date
  • applicationId
  • applicationName
  • deviceCount
  • eventCount

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

いいえ

要求の例

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/failurehits?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and deviceType eq 'phone' 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 です。
applicationName string アプリの表示名です。
failureName string エラーの名前です。1 つ以上の問題クラス、例外/バグチェックコード、エラーが発生したイメージの名前、および関連する関数名の 4 つの部分で構成されます。
failureHash string エラーの一意の識別子です。
symbol 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] (不明) になります。

eventType string 次の文字列のいずれかです。
  • crash
  • hang
  • memory
  • jse
market string デバイス市場の ISO 3166 の国コードです。
deviceType string エラーが発生したデバイスの種類を示す、以下のいずれかの文字列です。
  • PC
  • 電話
  • Console-Xbox One
  • Console-Xbox Series X
  • IoT
  • Holographic
  • 不明
packageName string このエラーに関連付けられているアプリ パッケージの一意の名前です。
packageVersion string このエラーに関連付けられているアプリ パッケージのバージョンです。
deviceCount 数値 指定した集計レベルでの、このエラーに対応する一意のデバイスの数です。
eventCount 数値 指定された集計レベルでの、このエラーに起因するイベント数です。

Note

このメソッドで取得できるのは、過去 30 日以内に発生したエラーのみです。

要求と応答の例

以下のコード スニペットは、要求の例、およびこれらの要求の JSON 返信の本文を示しています。

サンプル要求

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/failurehits?applicationId=9NBLGGGZ5QDR&startDate=07/02/2022&endDate=07/20/2022&top=10&skip=0&filter=market eq 'US'&groupby=failureName,failureHash,symbol,osVersion,eventType,market,deviceType,packageName,packageVersion,osRelease&orderby=date
HTTP/1.1
Authorization: Bearer <your access token>

サンプル応答

{
    "Value": [
        {
            "date": "2022-07-21",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "failureName": "APPLICATION_HANG_BlockedOn_FileIO_Microsoft.Contoso Demo!CEServices.InternalLiveTileUpdaterRuntime_dfffffff_Microsoft.Contoso Demo!unknown_error_in_application",
            "failureHash": "c21da75f-ea4d-538b-cfec-73654ef810b9",
            "symbol": "Microsoft.Contoso Demo!unknown_error_in_application",
            "osVersion": "6.3.9600",
            "osRelease": "RTM",
            "osArchitecture": null,
            "eventType": "hang",
            "market": "US",
            "deviceType": "PC",
            "praid": null,
            "packageName": "microsoft.Contoso Demo_2.5.2.34894_x86__8wekyb3d8bbwe",
            "packageVersion": "2.5.2.34894",
            "ram": null,
            "massStorage": null,
            "cpu": null,
            "cpuManufacturer": null,
            "cpuFamilyName": null,
            "sandboxId": null,
            "deviceCount": 6.0,
            "eventCount": 1.05263157894737
        },
        {
            "date": "2022-07-21",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "failureName": "APPLICATION_HANG_BlockedOn_FileIO_Microsoft.Contoso Demo!CEServices.InternalLiveTileUpdaterRuntime_dfffffff_Microsoft.Contoso Demo!unknown_error_in_application",
            "failureHash": "c21da75f-ea4d-538b-cfec-73654ef810b9",
            "symbol": "Microsoft.Contoso Demo!unknown_error_in_application",
            "osVersion": "6.3.9600",
            "osRelease": "RTM",
            "osArchitecture": null,
            "eventType": "hang",
            "market": "US",
            "deviceType": "Unknown",
            "praid": null,
            "packageName": "microsoft.Contoso Demo_2.5.2.34894_x86__8wekyb3d8bbwe",
            "packageVersion": "2.5.2.34894",
            "ram": null,
            "massStorage": null,
            "cpu": null,
            "cpuManufacturer": null,
            "cpuFamilyName": null,
            "sandboxId": null,
            "deviceCount": 7.14285714285714,
            "eventCount": 1.05263157894737
        },
        {
            "date": "2022-07-21",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "failureName": "APPLICATION_HANG_Microsoft.Contoso Demo!CEServices.InternalLiveTileUpdaterRuntime_dfffffff_twinapi.appcore.dll!WaitCoalesced",
            "failureHash": "233e04bb-7a3d-eb28-c316-1120aa9defc0",
            "symbol": "twinapi.appcore.dll!WaitCoalesced",
            "osVersion": "6.3.9600",
            "osRelease": "RTM",
            "osArchitecture": null,
            "eventType": "hang",
            "market": "US",
            "deviceType": "PC",
            "praid": null,
            "packageName": "microsoft.Contoso Demo_2.5.2.34894_x86__8wekyb3d8bbwe",
            "packageVersion": "2.5.2.34894",
            "ram": null,
            "massStorage": null,
            "cpu": null,
            "cpuManufacturer": null,
            "cpuFamilyName": null,
            "sandboxId": null,
            "deviceCount": 6.0,
            "eventCount": 8.94736842105263
        }
    ],
    "@nextLink": "failurehits?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=2022/07/02&endDate=2022/07/21&top=10&skip=10&groupby=failureName,failureHash,symbol,osVersion,eventType,market,deviceType,packageName,packageVersion,osRelease&filter=market eq 'US'&orderby=date",
    "TotalCount": 443
}