Microsoft Store 分析 API の次のメソッドを使用して、特定の日付範囲とその他のオプションフィルターの JSON 形式でアプリの集計エラー報告データを取得します。 このメソッドは、過去 30 日間に発生したエラーのみを取得できます。 この情報は、パートナー センターの 正常性レポート の Failures セクションでも確認できます。
追加のエラー情報を取得するには、エラーの詳細を取得するメソッド、スタックトレースを取得するメソッド、および CAB ファイルをダウンロードする メソッドを使用します。
[前提条件]
このメソッドを使用するには、まず次の操作を行う必要があります。
- まだ行っていない場合は、Microsoft Store 分析 API の
前提条件をすべて満たしてください。 - このメソッドの要求ヘッダーで使用する Azure AD アクセス トークン を取得します。 アクセス トークンを取得すると、有効期限が切れるまで 60 分かかります。 トークンの有効期限が切れた後、新しいトークンを取得できます。
リクエスト
リクエスト構文
メソッド | URI リクエスト |
---|---|
取得する | https://manage.devcenter.microsoft.com/v1.0/my/analytics/failurehits |
リクエストヘッダー
ヘッダ | タイプ | 説明 |
---|---|---|
認証 | ひも | 必須。 Bearer<token> 形式の Azure AD アクセス トークン。 |
要求パラメーター
パラメーター | タイプ | 説明 | 必須 |
---|---|---|---|
アプリケーションID | ひも | エラー報告データを取得するアプリのストア ID。 ストア ID は、パートナー センターの [アプリ ID] ページ で使用できます。 ストア ID の例は 9WZDNCRFJ3Q8 です。 | イエス |
開始日 | 日付 | 取得するエラー報告データの日付範囲の開始日。 既定値は現在の日付です。 aggregationLevel |
いいえ |
終了日 | 日付 | 取得するエラー報告データの日付範囲の終了日。 既定値は現在の日付です。 aggregationLevel |
いいえ |
ページのトップへ | 整数 (int) | 要求で返されるデータの行数。 最大値と既定値 (指定しない場合) は 10000 です。 クエリにさらに行がある場合、応答本文には次のリンクが含まれています。このリンクを使用して、データの次のページを要求できます。 | いいえ |
スキップ | 整数 (int) | クエリでスキップする行数。 大きなデータ セットをページングするには、このパラメーターを使用します。 たとえば、top=10000 と skip=0 はデータの最初の 10000 行を取得し、top=10000 と skip=10000 は次の 10000 行のデータを取得します。 | いいえ |
フィルター | ひも | 応答内の行をフィルター処理する 1 つ以上のステートメント。 各ステートメントには、応答本文のフィールド名と、eq または ne 演算子に関連付けられている値が含まれており、ステートメントは、、、、またはを使用して結合できます。 文字列値は、 フィルター パラメーター内で一重引用符で囲む必要があります。 応答本文から次のフィールドを指定できます。
|
いいえ |
集約レベル | ひも | 集計データを取得する時間範囲を指定します。 使用できる文字列は、 時間、 日、 週、または 月のいずれかです。 指定しない場合、既定値は day です。 週 または 月を指定した場合、failureName と failureHash の値は1000バケットに制限されます。 手記:時間を指定した場合は、過去 72 時間からのみエラー データを取得できます。 72 時間より前のエラー データを取得するには、 日 または他の集計レベルのいずれかを指定します。 | いいえ |
オーダーバイ (orderby) | ひも | 結果データ値を並べ替えるステートメント。 構文は *orderby=field [order]です。
フィールド パラメーターには、次の文字列のうち 1 つだけを指定できます。
order パラメーターは省略可能で、asc または desc を使用して各フィールドの昇順または降順を指定できます。 既定値は asc orderby 文字列の例を次に示します。orderby=date 注: パラメーターは 、groupby でサポートされているリストに含まれている必要があります。 |
いいえ |
グループバイ | ひも | 指定したフィールドにのみデータ集計を適用するステートメント。 次のフィールドを指定できます。
返されるデータ行には、 groupby パラメーターで指定されたフィールドと、次のものが含まれます。
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 | ひも | 追加のデータ ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。 たとえば、この値は、要求の top パラメーターが 10000 に設定されているが、クエリに 1,0000 行を超えるエラーがある場合に返されます。 |
トータルカウント | 整数 (integer) | クエリのデータ結果内の行の合計数。 |
エラー値
Value 配列内の要素には、次の値が含まれています。
価値 | タイプ | 説明 |
---|---|---|
日付 | ひも | エラー データの日付範囲の最初の日付 (yyyy-mm-dd 形式)。 要求で 1 日が指定されている場合、この値はその日付になります。 要求で長い日付範囲が指定されている場合、この値はその日付範囲の最初の日付になります。
時間の aggregationLevel 値を指定する要求の場合、この値には hh:mm:ss 形式の時刻値も含まれます。 |
アプリケーションID | ひも | エラー データを取得するアプリのストア ID。 |
アプリケーション名 | ひも | アプリの表示名。 |
エラー名 | ひも | エラーの名前。1 つ以上の問題クラス、例外/バグ チェック コード、エラーが発生したイメージの名前、および関連する関数名の 4 つの部分で構成されます。 |
failureHash (フェイリャーハッシュ) | ひも | エラーの識別子(ユニーク ID)。 |
記号 | ひも | このエラーに割り当てられたシンボル。 |
osVersion (英語) | ひも | エラーが発生した OS バージョンを指定する次のいずれかの文字列。
|
osリリース | ひも | エラーが発生した OS リリースまたはフライト リング (OS バージョン内のサブ集団として) を指定する次の文字列のいずれか。 Windows 11 の場合: バージョン 2110 Windows 10 の場合:
Windows Server 1709 の場合:
Windows Server 2016 の場合:
Windows 8.1 の場合:
Windows 7 の場合:
OS リリースまたはフライティング リングが不明な場合、このフィールドの値は [不明] になります。 |
イベントタイプ | ひも | 次のいずれかの文字列:
|
市場 | ひも | デバイス市場の ISO 3166 国コード。 |
デバイスタイプ | ひも | エラーが発生したデバイスの種類を示す次のいずれかの文字列。
|
パッケージ名 | ひも | このエラーに関連付けられているアプリ パッケージの一意の名前。 |
パッケージバージョン | ひも | このエラーに関連付けられているアプリ パッケージのバージョン。 |
デバイス数 | 数 | 指定した集計レベルのこのエラーに対応する一意のデバイスの数。 |
イベント数 | 数 | 指定された集計レベルでこのエラーに起因するイベントの数。 |
注
このメソッドは、過去 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
}
関連トピック
- 健康報告書
- アプリ でエラーの詳細を取得する
- アプリのエラーのスタック トレースを取得
- アプリでエラーが発生した場合は CAB ファイルをダウンロード
- Microsoft Store サービス を使用して分析データにアクセスする
- アプリの買収
- アドオンを取得する
- アプリの評価 を取得する
- アプリ レビューを取得する