取得傳統型應用程式中錯誤的詳細資料

  • 發行項

在 Microsoft Store 分析 API 中使用此方法，取得應用程式特定錯誤的 JSON 格式詳細資料。 此方法只能擷取過去 30 天內發生之錯誤的詳細資料。 詳細錯誤資料也可在合作夥伴中心傳統型應用程式的健康情況報告中取得。

使用此方法之前，您必須先使用取得錯誤報告資料方法來擷取您想要取得詳細資訊的錯誤識別碼。

必要條件

要使用此方法，您需要先執行以下操作：

  • 如果您尚未執行此操作，請完成 Microsoft Store 分析 API 的所有必要條件。
  • 取得 Azure AD 存取權杖以便用於此方法的要求標頭中。 取得存取權杖之後，您在其到期之前有 60 分鐘的時間可以使用。 權杖到期之後，您可以取得新的權杖。
  • 取得您想要取得詳細資訊之錯誤的識別碼。 若要取得此識別碼，請使用取得錯誤報告資料方法，並在該方法的回應本文中使用 failureHash 值。

要求

要求語法

方法 要求 URI
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failuredetails

要求標頭

標題 類型 描述
授權 字串 必要。 持有人<權杖>形式的 Azure AD 存取權杖。

要求參數

參數 類型 描述 必要
applicationId 字串 您想要擷取錯誤詳細資料之傳統型應用程式的產品識別碼。 若要取得傳統型應用程式的產品識別碼，請在合作夥伴中心開啟傳統型應用程式的任何分析報告 (例如健康情況報告)，並從 URL 擷取產品識別碼。 是
failureHash 字串 取得您想要取得詳細資訊之錯誤的唯一識別碼。 若要針對您感興趣的錯誤取得此值，請使用取得錯誤報告資料方法，並在該方法的回應本文中使用 failureHash 值。 是
startDate date 要擷取詳細錯誤資料之日期範圍的開始日期。 預設值為目前日期的前 30 天。

：此方法只能擷取過去 30 天內發生之錯誤的詳細資料。		 否
endDate date 要擷取詳細錯誤資料之日期範圍的結束日期。 預設值是目前的日期。 否
熱門 int 要求中要傳回的資料列數。 如果未指定，則最大值和預設值為 10000。 如果查詢中有更多資料列，回應本文會包含下一個連結，您可以用來要求下一頁的資料。 否
skip int 要在查詢中忽略的列數。 使用此參數逐頁瀏覽大型資料集。 例如，top=10 和 skip=0 會擷取前 10 列資料，top=10 和 skip=10 會擷取接下來的 10 列資料，依此類推。 否
篩選器 字串 篩選回應中的資料列的一或多個陳述式。 每個陳述式都包含回應本文的功能變數名稱，以及與 eq 或 ne 運算子相關聯的值，而且可以使用 and 或 or 結合陳述式。 字串值必須以 filter 參數中的單引號括住。 您可以從回應本文指定下列功能變數：

  • market
  • date
  • cabIdHash
  • cabExpirationTime
  • deviceType
  • deviceModel
  • osVersion
  • osRelease
  • applicationVersion
  • osBuild
  • fileName
 否
orderby 字串 排序結果資料值的陳述式。 語法為 orderby=field [order],field [order],...。field 參數可以是下列其中一個字串：
  • market
  • date
  • cabIdHash
  • cabExpirationTime
  • deviceType
  • deviceModel
  • osVersion
  • osRelease
  • applicationVersion
  • osBuild
  • fileName

order 參數是選擇性的，而且可以是 asc 或 desc，以指定每個欄位的遞增或遞減順序。 預設為asc。

以下是範例 orderby 字串：orderby=date,market

 否

要求範例

下列範例示範數個取得詳細錯誤資料的要求。 以傳統型應用程式的產品識別碼取代 applicationId 值。

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 字串 如果有額外的資料頁面，此字串會包含可用來要求下一頁資料的 URI。 例如，如果要求的 top 參數設定為 10，但查詢的錯誤超過 10 個資料列，則會傳回此值。
TotalCount 整數 查詢的資料結果中的總列數。

錯誤詳細資料值

Value 陣列中的元素包含下列值。

值 類型 描述
applicationId 字串 您已擷取錯誤詳細資料之傳統型應用程式的產品識別碼。
failureHash 字串 錯誤的唯一識別碼。
failureName 字串 失敗的名稱，由四個部分組成：一或多個問題類別、例外狀況/錯誤檢查代碼、發生失敗的映像名稱，以及相關聯的函式名稱。
date 字串 錯誤資料之日期範圍中的第一個日期。 如果要求指定了單天，這個值就是該日期。 如果要求指定了一週、月或其他日期範圍，這個值就是該日期範圍中的第一個日期。
cabIdHash 字串 與此錯誤相關聯之 CAB 檔案的唯一識別碼雜湊。
cabExpirationTime 字串 CAB 檔案過期且無法再下載的日期和時間，格式為 ISO 8601。
market 字串 裝置市場的 ISO 3166 國家/地區代碼。
osBuild 字串 發生錯誤之 OS 的組建編號。
applicationVersion 字串 發生錯誤的應用程式可執行檔版本。
deviceModel 字串 指定發生錯誤時應用程式執行所在裝置模型的字串。
osVersion 字串 下列其中一個字串，指定安裝傳統型應用程式的 OS 版本：

  • Windows 7
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Windows Server 2016
  • Windows Server 1709
  • Unknown
osRelease 字串 下列其中一個字串，指定發生錯誤的 OS 版本或發行小眾測試版通道 (作為 OS 版本內的子群體)。

若為 Windows 11：2110 版

若為 Windows 10：

  • 1507 版
  • 1511 版
  • 1607 版
  • 1703 版
  • 1709 版
  • 1803 版
  • Release Preview
  • Insider Fast
  • Insider Slow

若是 Windows Server 1709：

  • RTM

若是 Windows Server 2016：

  • 1607 版

若為 Windows 8.1：

  • Update 1

若為 Windows 7：

  • Service Pack 1

如果 OS 版本或發行小眾測試版通道不明，此功能變數的值為 Unknown。
deviceType 字串 下列其中一個字串，指出發生錯誤的裝置類型：

  • PC
  • Server
  • Unknown
cabDownloadable 布林值 指出對於此使用者，是否可下載 CAB 檔案。
fileName 字串 您已擷取錯誤詳細資料之傳統型應用程式的可執行檔名稱。

回應範例

下列範例示範此要求的範例 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
}