Obtenir les informations sur une erreur de votre application de bureauGet details for an error in your desktop application

Utilisez cette méthode dans l’API Microsoft Store Analytics pour obtenir des données détaillées pour une erreur spécifique pour votre application au format JSON.Use this method in the Microsoft Store analytics API to get detailed data for a specific error for your app in JSON format. Cette méthode ne récupère que les informations concernant les erreurs survenues dans les 30 derniers jours.This method can only retrieve details for errors that occurred in the last 30 days. Des données d’erreur détaillées sont également disponibles dans le rapport d’intégrité pour les applications de bureau dans l’espace partenaires.Detailed error data is also available in the Health report for desktop applications in Partner Center.

Pour utiliser cette méthode, vous devez d’abord utiliser la méthode Obtenir les données de rapport d’erreurs afin de récupérer l’ID de l’erreur sur laquelle vous souhaitez des informations détaillées.Before you can use this method, you must first use the get error reporting data method to retrieve the ID of the error for which you want to get detailed info.

PrérequisPrerequisites

Pour utiliser cette méthode, vous devez d’abord effectuer les opérations suivantes :To use this method, you need to first do the following:

  • Si vous ne l’avez pas déjà fait, renseignez toutes les conditions préalables pour l’API Microsoft Store Analytics.If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
  • Obtenez un jeton d’accès Azure AD à utiliser dans l’en-tête de requête de cette méthode.Obtain an Azure AD access token to use in the request header for this method. Une fois que vous avez récupéré le jeton d’accès, vous avez 60 minutes pour l’utiliser avant qu’il n’expire.After you obtain an access token, you have 60 minutes to use it before it expires. Une fois le jeton arrivé à expiration, vous pouvez en obtenir un nouveau.After the token expires, you can obtain a new one.
  • Récupérez l’ID de l’erreur sur laquelle vous souhaitez des informations détaillées.Get the ID of the error for which you want to get detailed info. Pour ce faire, utilisez la méthode Obtenir les données de rapport d’erreurs et utilisez la valeur failureHash dans le corps de la réponse de cette méthode.To get this ID, use the get error reporting data method and use the failureHash value in the response body of that method.

RequêteRequest

Syntaxe de la requêteRequest syntax

MéthodeMethod URI de demandeRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failuredetails

En-tête de requêteRequest header

En-têteHeader TypeType DescriptionDescription
AutorisationAuthorization stringstring Obligatoire.Required. Jeton d’accès Azure AD sous la forme Bearer <jeton>.The Azure AD access token in the form Bearer <token>.

Paramètres de la demandeRequest parameters

ParamètreParameter TypeType DescriptionDescription ObligatoireRequired
applicationIdapplicationId stringstring ID de produit de l’application de bureau pour laquelle vous souhaitez récupérer les détails de l’erreur.The product ID of the desktop application for which you want to retrieve error details. Pour obtenir l’ID de produit d’une application de bureau, ouvrez un rapport analytique pour votre application de bureau dans l’espace partenaires (par exemple, le rapport d’intégrité) et récupérez l’ID de produit à partir de l’URL.To get the product ID of a desktop application, open any analytics report for your desktop application in Partner Center (such as the Health report) and retrieve the product ID from the URL. OuiYes
failureHashfailureHash stringstring ID de l’erreur sur laquelle vous souhaitez des informations détaillées.The unique ID of the error for which you want to get detailed info. Pour obtenir la valeur correspondant à l’erreur qui vous intéresse, utilisez la méthode Obtenir les données de rapport d’erreurs et utilisez la valeur failureHash dans le corps de la réponse de cette méthode.To get this value for the error you are interested in, use the get error reporting data method and use the failureHash value in the response body of that method. OuiYes
startDatestartDate Datedate Date de début des données à récupérer concernant l’erreur.The start date in the date range of detailed error data to retrieve. La valeur par défaut est de 30 jours avant la date actuelle.The default is 30 days before the current date.

Remarque :     Cette méthode peut uniquement récupérer les détails des erreurs qui se sont produites au cours des 30 derniers jours.Note:  This method can only retrieve details for errors that occurred in the last 30 days.

NonNo
endDateendDate Datedate Date de fin des données à récupérer concernant l’erreur.The end date in the date range of detailed error data to retrieve. La valeur par défaut est la date actuelle.The default is the current date. NonNo
toptop intint Le nombre de lignes de données à renvoyer dans la requête.The number of rows of data to return in the request. La valeur maximale et la valeur par défaut en l’absence de définition est 10000.The maximum value and the default value if not specified is 10000. Si la requête comporte davantage de lignes, le corps de la réponse inclut un lien sur lequel vous cliquez pour solliciter la page suivante de données.If there are more rows in the query, the response body includes a next link that you can use to request the next page of data. NonNo
skipskip intint Le nombre de lignes à ignorer dans la requête.The number of rows to skip in the query. Utilisez ce paramètre pour parcourir de grands ensembles de données.Use this parameter to page through large data sets. Par exemple, indiquez top=10 et skip=0 pour obtenir les 10 premières lignes de données, top=10 et skip=10 pour obtenir les 10 lignes suivantes, et ainsi de suite.For example, top=10 and skip=0 retrieves the first 10 rows of data, top=10 and skip=10 retrieves the next 10 rows of data, and so on. NonNo
Filterfilter stringstring Une ou plusieurs instructions qui filtrent les lignes de la réponse.One or more statements that filter the rows in the response. Chaque instruction contient un nom de champ du corps de la réponse et une valeur qui sont associés aux opérateurs EQ ou ne, et les instructions peuvent être combinées à l’aide de and ou de ou de.Each statement contains a field name from the response body and value that are associated with the eq or ne operators, and statements can be combined using and or or. Les valeurs de chaîne doivent être entourées par des guillemets dans le paramètre filter.String values must be surrounded by single quotes in the filter parameter. Vous pouvez spécifier les champs suivants dans le corps de la réponse :You can specify the following fields from the response body:

  • négocimarket
  • datedate
  • cabIdHashcabIdHash
  • cabExpirationTimecabExpirationTime
  • deviceTypedeviceType
  • deviceModeldeviceModel
  • osVersionosVersion
  • osReleaseosRelease
  • applicationVersionapplicationVersion
  • osBuildosBuild
  • fileNamefileName
NonNo
orderbyorderby stringstring Instruction commandant les valeurs des données de résultats.A statement that orders the result data values. La syntaxe est orderby = Field [Order], champ [Order],.... Le paramètre Field peut être l’une des chaînes suivantes :The syntax is orderby=field [order],field [order],.... The field parameter can be one of the following strings:
  • négocimarket
  • datedate
  • cabIdHashcabIdHash
  • cabExpirationTimecabExpirationTime
  • deviceTypedeviceType
  • deviceModeldeviceModel
  • osVersionosVersion
  • osReleaseosRelease
  • applicationVersionapplicationVersion
  • osBuildosBuild
  • fileNamefileName

Le paramètre order, facultatif, peut comporter les valeurs asc ou desc afin de spécifier l’ordre croissant ou décroissant pour chaque champ.The order parameter is optional, and can be asc or desc to specify ascending or descending order for each field. La valeur par défaut est ASC.The default is asc.

Voici un exemple de chaîne orderby : orderby = date, MarketHere is an example orderby string: orderby=date,market

NonNo

Exemple de requêteRequest example

Les exemples suivants fournissent plusieurs requêtes permettant de récupérer des données d’erreur.The following examples demonstrate several requests for getting detailed error data. Remplacez la valeur ApplicationID par l’ID de produit de votre application de bureau.Replace the applicationId value with the product ID for your desktop application.

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>

responseResponse

Response bodyResponse body

ValeurValue TypeType DescriptionDescription
ValeurValue tableauarray Tableau d’objets comportant des données d’erreur détaillées.An array of objects that contain detailed error data. Pour plus d’informations sur les données de chaque objet, consultez la section Valeurs des informations d’erreur ci-dessous.For more information about the data in each object, see the error detail values section below.
@nextLink stringstring S’il existe des pages supplémentaires de données, cette chaîne comporte un URI que vous pouvez utiliser pour solliciter la page suivante de données.If there are additional pages of data, this string contains a URI that you can use to request the next page of data. Par exemple, cette valeur est renvoyée si le paramètre top de la requête est défini sur 10, mais que plus de 10 lignes d’erreur sont associées à la requête.For example, this value is returned if the top parameter of the request is set to 10 but there are more than 10 rows of errors for the query.
TotalCountTotalCount entierinteger Nombre total de lignes dans les résultats de la requête.The total number of rows in the data result for the query.

Valeurs des informations d’erreurError detail values

Les éléments du tableau Value comportent les valeurs suivantes :Elements in the Value array contain the following values.

ValeurValue TypeType DescriptionDescription
applicationIdapplicationId stringstring ID de produit de l’application de bureau pour laquelle vous avez récupéré les détails de l’erreur.The product ID of the desktop application for which you retrieved error details.
failureHashfailureHash stringstring Identificateur unique de l’erreur.The unique identifier for the error.
failureNamefailureName stringstring Nom de l’échec, qui est constitué de quatre parties : une ou plusieurs classes de problème, un code de vérification des exceptions/bogues, le nom de l’image où l’échec s’est produit et le nom de la fonction associée.The name of the failure, which is made up of four parts: one or more problem classes, an exception/bug check code, the name of the image where the failure occurred, and the associated function name.
Datedate stringstring Date de début des données d’erreur.The first date in the date range for the error data. Si la requête spécifiait un jour précis, cette valeur correspond à la date.If the request specified a single day, this value is that date. Si la requête était relative à une semaine, un mois ou toute autre plage de dates, cette valeur correspond à la première date de la plage de dates.If the request specified a week, month, or other date range, this value is the first date in that date range.
cabIdHashcabIdHash stringstring Hachage d’ID unique du fichier CAB associé à cette erreur.The unique ID hash of the CAB file that is associated with this error.
cabExpirationTimecabExpirationTime stringstring Date et heure auxquelles le fichier CAB est arrivé à expiration et n’est plus téléchargeable au format ISO 8601.The date and time when the CAB file is expired and can no longer be downloaded, in ISO 8601 format.
marketmarket stringstring Code pays ISO 3166 du marché des appareils.The ISO 3166 country code of the device market.
osBuildosBuild stringstring Numéro de version du système d’exploitation sur lequel l’erreur s’est produite.The build number of the OS on which the error occurred.
applicationVersionapplicationVersion stringstring Version de l’exécutable de l’application dans laquelle l’erreur s’est produite.The version of the application executable in which the error occurred.
deviceModeldeviceModel stringstring Chaîne identifiant le modèle d’appareil sur lequel l’application s’exécutait lorsque l’erreur s’est produite.A string that specifies the model of the device on which the app was running when the error occurred.
osVersionosVersion stringstring L’une des chaînes suivantes qui spécifient la version du système d’exploitation sur laquelle l’application de bureau est installée :One of the following strings that specifies the OS version on which the desktop application is installed:

  • Windows 7Windows 7
  • Windows 8.1Windows 8.1
  • Windows 10Windows 10
  • Windows Server 2016Windows Server 2016
  • Windows Server 1709Windows Server 1709
  • UnknownUnknown
osReleaseosRelease stringstring L’une des chaînes suivantes qui spécifient la version du système d’exploitation ou la sonnerie de vol (sous la forme d’un sous-remplissage dans la version du système d’exploitation) sur laquelle l’erreur s’est produite.One of the following strings that specifies the OS release or flighting ring (as a subpopulation within OS version) on which the error occurred.

Pour Windows 10 :For Windows 10:

  • Version 1507Version 1507
  • Version 1511Version 1511
  • Version 1607Version 1607
  • Version 1703Version 1703
  • Version 1709Version 1709
  • Version 1803Version 1803
  • Version préliminaireRelease Preview
  • Insider rapidementInsider Fast
  • Insider lentInsider Slow

Pour Windows Server 1709 :For Windows Server 1709:

  • COMMERCIALERTM

Pour Windows Server 2016 :For Windows Server 2016:

  • Version 1607Version 1607

Pour Windows 8.1 :For Windows 8.1:

  • Update 1Update 1

Pour Windows 7 :For Windows 7:

  • Service Pack 1Service Pack 1

Si la version du système d’exploitation ou la sonnerie de vol est inconnue, ce champ a la valeur Unknown.If the OS release or flighting ring is unknown, this field has the value Unknown.

deviceTypedeviceType stringstring L’une des chaînes suivantes qui indique le type d’appareil sur lequel l’erreur s’est produite :One of the following strings that indicates the type of device on which the error occurred:

  • ORDINATEURSPC
  • ServeurServer
  • UnknownUnknown
cabDownloadablecabDownloadable BooleanBoolean Indique si le fichier CAB est téléchargeable par cet utilisateur.Indicates whether the CAB file is downloadable for this user.
fileNamefileName stringstring Nom du fichier exécutable pour l’application de bureau pour laquelle vous avez récupéré les détails de l’erreur.The name of the executable file for the desktop application for which you retrieved error details.

Exemple de réponseResponse example

L’exemple suivant représente un corps de réponse JSON pour cette requête.The following example demonstrates an example JSON response body for this request.

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