デスクトップ アプリケーションのエラーに関するスタック トレースの取得

  • [アーティクル]

Windows デスクトップ アプリケーション プログラムに追加したデスクトップ アプリケーションのエラーに関するスタック トレースを取得するには、Microsoft Store 分析 API の以下のメソッドを使います。 このメソッドでダウンロードできるのは、過去 30 日以内に発生したエラーに関するスタック トレースのみです。 スタック トレースは、パートナー センターにあるデスクトップ アプリケーションの状態レポートからも行うことができます。

このメソッドを使うには、その前にまず「デスクトップ アプリケーションのエラーに関する詳細情報の取得」のメソッドを使って、スタック トレースを取得するエラーに関連付けられた CAB ファイルの ID ハッシュを取得する必要があります。

前提条件

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

  • Microsoft Store 分析 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。
  • このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。 アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れたら新しいトークンを取得できます。
  • スタック トレースを取得するエラーに関連付けられた CAB ファイルの ID ハッシュを取得します。 この値を取得するには、「デスクトップ アプリケーションのエラーに関する詳細情報の取得」のメソッドを使ってアプリの特定のエラーに関する詳細情報を取得し、そのメソッドの応答本文に含まれる cabIdHash 値を使用します。

要求

要求の構文

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

要求ヘッダー

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

要求パラメーター

パラメーター 種類 説明 必須
applicationId string スタック トレースを取得するデスクトップ アプリケーションの製品 ID です。 デスクトップ アプリケーションの製品 ID を取得するには、パートナー センターでデスクトップ アプリケーションの分析レポートのいずれか (状態レポートなど) を開き、URL から製品 ID を取得します。 はい
cabIdHash string スタック トレースを取得するエラーに関連付けられた CAB ファイルの一意の ID ハッシュです。 この値を取得するには、「デスクトップ アプリケーションのエラーに関する詳細情報の取得」のメソッドを使ってアプリケーションの特定のエラーに関する詳細情報を取得し、そのメソッドの応答本文に含まれる cabIdHash 値を使用します。 はい

要求の例

次の例は、このメソッドを使ってスタック トレースを取得する方法を示しています。 applicationId パラメーターと cabIdHash パラメーターは、デスクトップ アプリケーションに合わせて適切な値に置き換えてください。

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/stacktrace?applicationId=10238467886765136388&cabIdHash=54ffb83a-e159-41d2-8158-f36f306cc01e HTTP/1.1
Authorization: Bearer <your access token>

[応答]

応答本文

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

スタック トレースの値

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

値 種類 説明
level string コール スタックでこの要素が表すフレーム番号です。
image string このスタック フレームで呼び出される関数が含まれている実行可能ファイルまたはライブラリ イメージの名前です。
関数 (function) string このスタック フレームで呼び出される関数の名前。 これは、アプリが実行可能ファイルまたはライブラリのシンボルを含んでいる場合のみ使用可能です。
offset string 関数の先頭を基準とした現在の命令のバイト オフセットです。

応答の例

この要求の JSON 返信の本文の例を次に示します。

{
  "Value": [
    {
      "level": "0",
      "image": "Contoso.ContosoApp",
      "function": "Contoso.ContosoApp.MainPage.DoWork",
      "offset": "0x25C"
    }
    {
      "level": "1",
      "image": "Contoso.ContosoApp",
      "function": "Contoso.ContosoApp.MainPage.Initialize",
      "offset": "0x26"
    }
    {
      "level": "2",
      "image": "Contoso.ContosoApp",
      "function": "Contoso.ContosoApp.Start",
      "offset": "0x66"
    }
  ],
  "@nextLink": null,
  "TotalCount": 3
}