Compartilhar via


Obter detalhes de um erro no aplicativo da área de trabalho

Use esse método na API de análise da Microsoft Store para obter dados detalhados de um erro específico para seu aplicativo no formato JSON. Esse método só pode recuperar detalhes de erros ocorridos nos últimos 30 dias. Dados de erro detalhados também estão disponíveis no relatório de integridade para aplicativos da área de trabalho no Partner Center.

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

Pré-requisitos

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

  • Se você ainda não fez isso, conclua todos os pré-requisitos da 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 esse 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 o ID do erro para o qual você deseja obter informações detalhadas. Para obter essa ID, use o método get error reporting data e use o valor failureHash no corpo da resposta desse método.

Solicitar

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

Cabeçalho Tipo Descrição
Autorização string Obrigatório. O token de acesso do Azure AD no Token<de portador> do formulário.

Parâmetros da solicitação

Parâmetro Tipo Descrição Obrigatório
applicationId string A ID do produto do aplicativo da área de trabalho para o qual você deseja recuperar os detalhes do erro. Para obter o ID do produto (product ID) de um aplicativo da área de trabalho, abra um relatório de análise para o aplicativo da área de trabalho na Central de Parceiros (como o relatório de integridade) e recupere o ID do produto (product ID) na 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 get error reporting data e use o valor failureHash no corpo da resposta desse método. Sim
startDate date A data de início no intervalo de datas de dados de erro detalhados a serem recuperados. O padrão é 30 dias antes da data atual.

Observação: 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 de dados de erro 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 padrão, se não for especificado, será 10.000. Se houver mais linhas na consulta, o corpo da resposta incluirá um proximo 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 esse 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
filtro string Uma ou mais instruções que filtram as linhas na resposta. Cada instrução contém um nome de campo do corpo da resposta e um valor associados aos operadores eq ou ne, e as instruções podem ser combinadas usando and ou or. Os valores de sequência devem estar entre aspas simples no parâmetro filter. Você pode especificar os seguintes campos no corpo da resposta:

  • market
  • date
  • cabIdHash
  • cabExpirationTime
  • deviceType
  • Modelo do dispositivo
  • 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:
  • market
  • date
  • cabIdHash
  • cabExpirationTime
  • deviceType
  • Modelo do dispositivo
  • osVersion
  • osRelease
  • applicationVersion
  • osBuild
  • fileName

O parâmetro order é opcional e pode ser asc ou desc para especificar ordem ascendente ou descendente para cada campo. O padrão é asc.

Este é um exemplo de sequência orderby: orderby=date,market

Não

Exemplo de solicitação

Os exemplos a seguir demonstram várias solicitações para obter dados de erro detalhados. Substitua o valor applicationId pelo ID do produto (product ID) do 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 matriz Uma matriz de objetos que contêm dados de erro detalhados. Para obter mais informações sobre os dados em cada objeto, consulte a seção de valores de detalhes do erro abaixo.
@nextLink string Se houver páginas adicionais de dados, essa sequência 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 for definido como 10, mas houver mais de 10 linhas de erros para a consulta.
TotalCount Número inteiro O número total de linhas no resultado de dados da consulta.

Valores de detalhe de erro

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

Valor Type Descrição
applicationId string A ID do produto do aplicativo da área de trabalho para o qual você recuperou os detalhes do erro.
failureHash string O identificador exclusivo para o erro.
failureName string O nome da falha, que é composto de quatro partes: uma ou mais classes de problema, um código de verificação de exceção/bug, o nome da imagem em que a falha ocorreu e o nome da função associada.
date string A primeira data no intervalo de datas dos dados de erro. Se a solicitação tiver especificado um único dia, esse valor será essa data. Se a solicitação tiver especificado uma semana, um mês ou outro intervalo de datas, esse valor será a primeira data nesse intervalo de datas.
cabIdHash string O hash de ID exclusivo do arquivo CAB associado a esse erro.
cabExpirationTime string A data e a hora em que o arquivo CAB expirou e não pode mais ser baixado, no formato ISO 8601.
market string O código de país ISO 3166 do mercado de dispositivos.
osBuild string O número de compilação do sistema operacional no qual o erro ocorreu.
applicationVersion string A versão do executável do aplicativo em que o erro ocorreu.
deviceModel string Uma cadeia de caracteres que especifica o modelo do dispositivo no qual o aplicativo estava sendo executado quando o erro ocorreu.
osVersion string Uma das seguintes sequências que especifica a versão do SO na 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 SO ou as versões de pré-lançamento (como uma subpopulação dentro da versão do SO) em que o erro ocorreu.

Para Windows 11: Versão 2110

Para Windows 10:

  • Versão 1507
  • Versão 1511
  • Versão 1607
  • Versão 1703
  • Versão 1709
  • Versão 1803
  • Release Preview
  • 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

Para Windows 8.1:

  • Atualização 1

Para Windows 7:

  • Service Pack 1

Se a versão do SO ou a versão de pré-lançamento for desconhecida, esse campo terá o valor Desconhecido.

deviceType string Uma das seguintes cadeias de caracteres que indica o tipo de dispositivo no qual o erro ocorreu:

  • Computador
  • Servidor
  • Desconhecido
cabTransferível Booliano Indica se o arquivo CAB pode ser baixado para este 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

Veja a seguir 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
}