Obter detalhes de um erro em seu aplicativo da área de trabalho

  • Artigo

Use este método na API de análise da Microsoft Store para obter dados detalhados de um erro específico do seu app no formato JSON. Este método só pode recuperar detalhes dos erros que ocorreram nos últimos 30 dias. Os dados detalhados de erro também estão disponíveis no relatório Integridade para aplicativos da área de trabalho no Partner Center.

Antes de usar este método, primeiro você deve usar o método obter dados de relatório de erros para recuperar a ID do erro para o qual você deseja obter informações detalhadas.

Pré-requisitos

Para usar este método, primeiro você precisa do seguinte:

  • Se você não tiver feito isso, conclua todos os pré-requisitos para a API de análise da Microsoft Store.
  • Obtenha um token de acesso do Azure AD a ser usado no cabeçalho da solicitação para este método. Após obter um token de acesso, você tem 60 minutos para usá-lo antes dele expirar. Depois que o token expirar, você poderá obter um novo.
  • Obtenha a ID do erro para o qual você deseja obter informações detalhadas. Para obter essa ID, use o método obter dados de relatório de erros e o valor failureHash no corpo da resposta desse método.

Solicitação

Sintaxe da solicitação

Método URI da solicitação
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failuredetails

Cabeçalho da solicitação

parâmetro Tipo Descrição
Autorização string Obrigatórios. O token de acesso Azure AD notoken> de portador< de formulário.

Parâmetros da solicitação

Parâmetro Tipo Descrição Obrigatório
applicationId string A ID de produto do aplicativo da área de trabalho para o qual você deseja recuperar os detalhes do erro. Para obter a ID do produto de um aplicativo da área de trabalho, abra qualquer relatório de análise para seu aplicativo da área de trabalho no Partner Center (como o relatório de integridade) e recupere a ID do produto da URL. Sim
failureHash string A ID exclusiva do erro para o qual você deseja obter informações detalhadas. Para obter esse valor para o erro no qual você está interessado, use o método obter dados de relatório de erros e o valor failureHash no corpo da resposta desse método. Sim
startDate date A data de início no intervalo de datas dos dados de erros detalhados a serem recuperados. O padrão é 30 dias antes da data atual.

Nota: Esse método só pode recuperar detalhes de erros ocorridos nos últimos 30 dias.		 Não
endDate date A data de término no intervalo de datas dos dados de erros detalhados a serem recuperados. O padrão é a data atual. Não
top INT O número de linhas de dados a serem retornadas na solicitação. O valor máximo e o valor padrão; se não forem especificados, será 10.000. Se houver mais linhas na consulta, o corpo da resposta incluirá um link que você poderá usar para solicitar a próxima página de dados. Não
skip INT O número de linhas a serem ignoradas na consulta. Use este parâmetro para percorrer grandes conjuntos de dados. Por exemplo, top=10 e skip=0 recuperam as primeiras 10 linhas de dados, top=10 e skip=10 recuperam as próximas 10 linhas de dados e assim por diante. Não
filter string Uma ou mais instruções que filtram as linhas na resposta. Cada instrução contém um nome de campo do corpo de resposta e um valor que estão associados aos operadores eq ou ne, e as instruções podem ser combinadas usando-se and ou or. Os valores de sequência devem estar entre aspas simples no parâmetro filter. Você pode especificar os campos a seguir do corpo da resposta:

  • Mercado
  • date
  • cabIdHash
  • cabExpirationTime
  • Devicetype
  • deviceModel
  • Osversion
  • osRelease
  • applicationVersion
  • osBuild
  • fileName
 Não
orderby string Uma instrução que ordena os valores dos dados de resultado. A sintaxe é orderby=field [order],field [order],.... O parâmetro field pode ser uma das seguintes sequências:
  • Mercado
  • date
  • cabIdHash
  • cabExpirationTime
  • Devicetype
  • deviceModel
  • Osversion
  • osRelease
  • applicationVersion
  • osBuild
  • fileName

O parâmetro order é opcional e pode ser asc ou desc para especificar a ordem crescente ou decrescente de cada campo. O padrão é asc.

Aqui está um exemplo de cadeia de caracteres orderby : orderby=date,market

 Não

Exemplo de solicitação

Os exemplos a seguir demonstram várias solicitações para a obtenção de dados de erros detalhados. Substitua o valor de applicationId pela ID do produto de seu aplicativo da área de trabalho.

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>

Resposta

Corpo da resposta

Valor Type Descrição
Valor array Uma matriz de objetos que contêm dados de erros detalhados. Para saber mais sobre os dados em cada objeto, consulte a seção de Valores de detalhes de erros a seguir.
@nextLink string Se houver páginas adicionais de dados, essa cadeia de caracteres conterá um URI que você poderá usar para solicitar a próxima página de dados. Por exemplo, esse valor será retornado se o parâmetro top da solicitação estiver definido como 10, mas houver mais de 10 linhas de erros para a consulta.
TotalCount inteiro O número total de linhas no resultado dos dados da consulta.

Valores de detalhes de erros

Os elementos na matriz Value contêm os valores a seguir.

Valor Type Descrição
applicationId string A ID de produto do aplicativo da área de trabalho para o qual você recuperou os detalhes do erro.
failureHash string O identificador exclusivo do erro.
failureName string O nome de falha, que é composto de quatro partes: uma ou mais classes de problema, um código de verificação de bug/exceção, o nome da imagem em que ocorreu a falha e o nome da função associada.
date string A primeira data no intervalo de datas dos dados do erro. Se a solicitação tiver especificado um único dia, o valor será essa data. Se a solicitação especificou uma semana, um mês ou outro intervalo de datas, o valor será a primeira data nesse intervalo de datas.
cabIdHash string O hash da ID exclusiva do arquivo CAB que está associado a esse erro.
cabExpirationTime string A data e a hora em que o arquivo CAB expirou e não pôde mais ser baixado, no formato ISO 8601.
market string O código de país ISO 3166 do mercado do dispositivo.
osBuild string O número de versão do sistema operacional no qual o erro ocorreu.
applicationVersion string A versão do executável do aplicativo em que ocorreu o erro.
deviceModel string Uma sequência que especifica o modelo do dispositivo no qual o app era executado quando o erro ocorreu.
osVersion string Uma das seguintes sequências que especifica a versão do sistema operacional no qual o aplicativo da área de trabalho está instalado:

  • Windows 7
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Windows Server 2016
  • Windows Server 1709
  • Desconhecido
osRelease string Uma das sequências a seguir que especifica a versão do sistema operacional ou anel de liberação de versões de pré-lançamento (como uma subpopulação na versão do sistema operacional) no qual o erro ocorreu.

Para Windows 11: Versão 2110

No Windows 10:

  • Versão 1507
  • Versão 1511
  • Versão 1607
  • Versão 1703
  • Versão 1709
  • Versão 1803
  • Versão prévia de lançamento
  • Participante do Programa Windows Insider - Modo Rápido
  • Participante do Programa Windows Insider - Modo Lento

Para o Windows Server 1709:

  • RTM

Para o Windows Server 2016:

  • Versão 1607

No Windows 8.1:

  • Atualização 1

No Windows 7:

  • Service Pack 1

Se a versão do sistema operacional ou anel de liberação de versão de pré-lançamento for desconhecida, este campo terá o valor Desconhecido.
deviceType string Uma das seguintes sequências que indica o tipo de dispositivo no qual ocorreu o erro:

  • PC
  • Servidor
  • Desconhecido
cabDownloadable Boolean Indica se o arquivo CAB está disponível para download para esse usuário.
fileName string O nome do arquivo executável do aplicativo da área de trabalho para o qual você recuperou os detalhes do erro.

Exemplo de resposta

O código a seguir demonstra um exemplo de corpo de resposta JSON para essa solicitação.

{
  "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
}