Obter dados de relatório de erros do seu aplicativo da área de trabalho
Use esse método na API de análise da Microsoft Store para obter dados agregados de relatório de erros para um aplicativo de área de trabalho que você adicionou ao programa de Aplicativos da Área de Trabalho do Windows. Este método só pode recuperar erros que ocorreram nos últimos 30 dias. Essas informações também estão disponíveis no relatório de Integridade para aplicativos da área de trabalho na Central de Parceiros.
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.
Solicitar
Sintaxe da solicitação
| Método | URI da solicitação |
|---|---|
| GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failurehits |
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 | O ID do produto (product ID) do aplicativo da área de trabalho para o qual você deseja recuperar dados de relatório de erros. 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 |
| startDate | date | A data de início no intervalo de datas dos dados de relatório de erros a serem recuperados, no formato mm/dd/yyyy. O padrão é a data atual.Nota: este método só pode recuperar erros que ocorreram nos últimos 30 dias. |
Não |
| endDate | date | A data de término no intervalo de datas dos dados de relatório de erros a serem recuperados, no formato mm/dd/yyyy. 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=10000 e skip=0 recupera as primeiras 10.000 mil linhas de dados, top=10000 e skip=10000 recupera as próximas dez mil 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:
|
Não |
| aggregationLevel | string | Especifica o intervalo de tempo cujos dados agregados serão recuperados. Pode ser uma das seguintes sequências: dia, semana ou mês. Se não for especificado, o padrão será dia. Se você especificar semana ou mês, os valores failureName e failureHash serão limitados a 1000 buckets. | 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:
Este é um exemplo de sequência orderby: orderby=date,market |
Não |
| groupby | string | Uma instrução que aplica agregação de dados somente aos campos especificados. Você pode especificar os seguintes campos:
As linhas de dados retornadas conterão os campos especificados no parâmetro groupby, bem como:
O parâmetro groupby pode ser usado com o parâmetro aggregationLevel. Por exemplo:: &groupby=failureName,market&aggregationLevel=week |
Não |
Exemplo de solicitação
Os exemplos a seguir demonstram várias solicitações para obter dados de relatório de erros. 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/failurehits?applicationId=10238467886765136388&startDate=1/1/2018&endDate=2/1/2018&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failurehits?applicationId=10238467886765136388&startDate=8/1/2017&endDate=8/31/2017&skip=0&filter=market eq 'US' and deviceType eq 'PC' HTTP/1.1
Authorization: Bearer <your access token>
Response
Corpo da resposta
| Valor | Type | Descrição |
|---|---|---|
| Valor | matriz | Uma matriz de objetos que contêm dados agregados de relatório de erros. Para obter mais informações sobre os dados em cada objeto, consulte a seção valores 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 estiver definido como 10000, mas se existirem mais de 10000 linhas de erros para a consulta. |
| TotalCount | Número inteiro | O número total de linhas no resultado de dados da consulta. |
Valores de erro
Os elementos na matriz Value contêm os valores a seguir.
| Valor | Type | Descrição |
|---|---|---|
| date | string | A primeira data no intervalo de datas para os dados de erros, no formato yyyy-mm-dd. Se a solicitação especificar um único dia, esse valor será essa data. Se a solicitação especificar um intervalo de datas mais longo, esse valor será a primeira data neste intervalo de datas. Para solicitações que especificam um valor de aggregationLevel de hora, esse valor também inclui um valor temporal no formato hh:mm:ss. |
| applicationId | string | O ID do produto (product ID) do aplicativo da área de trabalho para o qual você recuperou dados de erros. |
| productName | string | O nome de exibição do aplicativo da área de trabalho como derivado dos metadados dos seus executáveis associados. |
| appName | string | TBD |
| fileName | string | Obtém o nome do arquivo executável para o aplicativo da área de trabalho. |
| 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. |
| failureHash | string | O identificador exclusivo para o erro. |
| simbolo | string | O símbolo atribuído a esse erro. |
| osBuild | string | O número de build de quatro partes do SO no qual 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:
|
| 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:
Para o Windows Server 1709:
Para o Windows Server 2016:
Para Windows 8.1:
Para Windows 7:
Se a versão do SO ou a versão de pré-lançamento for desconhecida, esse campo terá o valor Desconhecido. |
| eventType | string | Uma das seguintes sequências que indica o tipo de evento de erro:
|
| market | string | O código de país ISO 3166 do mercado de dispositivos. |
| deviceType | string | Uma das seguintes sequências que especifica o tipo de dispositivo em que o erro ocorreu:
|
| applicationVersion | string | A versão do executável do aplicativo em que o erro ocorreu. |
| eventCount | number | O número de eventos atribuídos a esse erro para o nível de agregação especificado. |
Exemplo de resposta
Veja a seguir um exemplo de corpo de resposta JSON para essa solicitação.
{
"Value": [
{
"date": "2018-02-01",
"applicationId": "10238467886765136388",
"productName": "Contoso Demo",
"appName": "Contoso Demo",
"fileName": "contosodemo.exe",
"failureName": "SVCHOSTGROUP_localservice_IN_PAGE_ERROR_c0000006_hardware_disk!Unknown",
"failureHash": "11242ef3-ebd8-d525-838d-b5497b225695",
"symbol": "hardware_disk!Unknown",
"osBuild": "10.0.15063.850",
"osVersion": "Windows 10",
"osRelease": "Version 1703",
"eventType": "crash",
"market": "US",
"deviceType": "PC",
"applicationVersion": "2.2.2.0",
"eventCount": 0.0012422360248447205
}
],
"@nextLink": "desktop/failurehits?applicationId=10238467886765136388&aggregationLevel=week&startDate=2018/02/01&endDate2018/02/08&top=1&skip=1",
"TotalCount": 21
}
Tópicos relacionados
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de