Obtenir des informations concernant les blocs de mise à niveau pour votre application de bureauGet upgrade block details for your desktop application

Utilisez cet URI REST pour obtenir des détails sur les appareils Windows 10 sur lesquels un fichier exécutable spécifique dans votre application de bureau bloque l’exécution d’une mise à niveau vers Windows 10.Use this REST URI to get details for Windows 10 devices on which a specific executable in your desktop application is blocking a Windows 10 upgrade from running. Vous pouvez utiliser cet URI uniquement pour les applications de bureau que vous avez ajoutées au programme d’application de bureau Windows.You can use this URI only for desktop applications that you have added to the Windows Desktop Application program. Ces informations sont également disponibles dans le rapport des blocs d’application pour les applications de bureau dans l’espace partenaires.This information is also available in the Application blocks report for desktop applications in Partner Center.

Cet URI est similaire à obtenir les blocs de mise à niveau pour votre application de bureau, mais il retourne les informations de bloc de périphérique pour un exécutable spécifique dans votre application de bureau.This URI is similar to Get upgrade blocks for your desktop application, but it returns device block info for a specific executable in your desktop application.

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.

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/blockdetails

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 des données de bloc.The product ID of the desktop application for which you want to retrieve block data. 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 sur les blocs) et récupérez l’ID de produit 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 Blocks report) and retrieve the product ID from the URL. OuiYes
fileNamefileName stringstring Nom de l’exécutable bloquéThe name of the blocked executable
startDatestartDate Datedate Date de début dans la plage de dates des données de bloc à récupérer.The start date in the date range of block data to retrieve. La valeur par défaut est de 90 jours avant la date actuelle.The default is 90 days prior to the current date. NonNo
endDateendDate Datedate Date de fin dans la plage de dates des données de bloc à récupérer.The end date in the date range of block 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=10000 et skip=0 pour obtenir les 10000 premières lignes de données, top=10000 et skip=10000 pour obtenir les 10000 lignes suivantes, et ainsi de suite.For example, top=10000 and skip=0 retrieves the first 10000 rows of data, top=10000 and skip=10000 retrieves the next 10000 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:

  • applicationVersionapplicationVersion
  • architecturearchitecture
  • blockTypeblockType
  • deviceTypedeviceType
  • négocimarket
  • osReleaseosRelease
  • osVersionosVersion
  • productNameproductName
  • targetOstargetOs
NonNo
orderbyorderby stringstring Instruction qui classe les valeurs des données de résultat pour chaque bloc.A statement that orders the result data values for each block. La syntaxe est orderby = Field [Order], champ [Order],.... Le paramètre Field peut être l’un des champs suivants du corps de la réponse :The syntax is orderby=field [order],field [order],.... The field parameter can be one of the following fields from the response body:

  • applicationVersionapplicationVersion
  • architecturearchitecture
  • blockTypeblockType
  • datedate
  • deviceTypedeviceType
  • négocimarket
  • osReleaseosRelease
  • osVersionosVersion
  • productNameproductName
  • targetOstargetOs
  • deviceCountdeviceCount

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
groupbygroupby stringstring Une instruction qui applique l’agrégation des données uniquement sur les champs spécifiés.A statement that applies data aggregation only to the specified fields. Vous pouvez spécifier les champs suivants dans le corps de la réponse :You can specify the following fields from the response body:

  • applicationVersionapplicationVersion
  • architecturearchitecture
  • blockTypeblockType
  • deviceTypedeviceType
  • négocimarket
  • osReleaseosRelease
  • osVersionosVersion
  • targetOstargetOs

Les lignes de données renvoyées comportent les champs spécifiés dans le paramètre groupby, ainsi que dans les paramètres suivants :The returned data rows will contain the fields specified in the groupby parameter as well as the following:

  • applicationIdapplicationId
  • datedate
  • productNameproductName
  • deviceCountdeviceCount

NonNo

Exemple de requêteRequest example

L’exemple suivant illustre plusieurs demandes d’obtention de données de bloc d’application de bureau.The following example demonstrates several requests for getting desktop application block 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/blockdetails?applicationId=10238467886765136388&fileName=contoso.exe&startDate=2018-05-01&endDate=2018-06-07&skip=0 HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockdetails?applicationId=10238467886765136388&fileName=contoso.exe&startDate=2018-05-01&endDate=2018-06-07&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 qui contiennent des données de bloc d’agrégation.An array of objects that contain aggregate block data. Pour plus d’informations sur les données de chaque objet, consultez le tableau suivant.For more information about the data in each object, see the following table.
@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 retournée si le paramètre supérieur de la demande est défini sur 10000, mais qu’il y a plus de 10000 lignes de données de bloc pour la requête.For example, this value is returned if the top parameter of the request is set to 10000 but there are more than 10000 rows of block data for the query.
TotalCountTotalCount intint Nombre total de lignes dans les résultats de la requête.The total number of rows in the data result for the query.

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é des données de bloc.The product ID of the desktop application for which you retrieved block data.
Datedate stringstring Date associée à la valeur des occurrences de bloc.The date associated with the block hits value.
ProductNameproductName stringstring Nom complet de l’application de bureau déduite des métadonnées de ses exécutables associés.The display name of the desktop application as derived from the metadata of its associated executable(s).
fileNamefileName stringstring Exécutable qui a été bloqué.The executable that was blocked.
applicationVersionapplicationVersion stringstring Version de l’exécutable de l’application qui a été bloquée.The version of the application executable that was blocked.
osVersionosVersion stringstring L’une des chaînes suivantes qui spécifie la version du système d’exploitation sur laquelle l’application de bureau est en cours d’exécution :One of the following strings that specifies the OS version on which the desktop application is currently running:

  • 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’application de bureau est en cours d’exécution.One of the following strings that specifies the OS release or flighting ring (as a subpopulation within OS version) on which the desktop application is currently running.

Pour Windows 10 :For Windows 10:

  • Version 1507Version 1507
  • Version 1511Version 1511
  • Version 1607Version 1607
  • Version 1703Version 1703
  • Version 1709Version 1709
  • 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.

marketmarket stringstring Code du pays ISO 3166 du marché dans lequel l’application de bureau est bloquée.The ISO 3166 country code of the market in which the desktop application is blocked.
deviceTypedeviceType stringstring L’une des chaînes suivantes qui spécifie le type de périphérique sur lequel l’application de bureau est bloquée :One of the following strings that specifies the type of device on which the desktop application is blocked:

  • ORDINATEURSPC
  • ServeurServer
  • TabletTablet
  • UnknownUnknown
blockTypeblockType stringstring L’une des chaînes suivantes qui spécifie le type de bloc trouvé sur l’appareil :One of the following strings that specifies the type of block found on the device:

  • Sédiment potentielPotential Sediment
  • Sédiment temporaireTemporary Sediment
  • Notification d’exécutionRuntime Notification

Pour plus d’informations sur ces types de bloc et sur ce qu’ils signifient pour les développeurs et les utilisateurs, consultez la description du rapport des blocs d’application.For more information about these block types and what they mean to developers and users, see the description of the Application blocks report.

architecturearchitecture stringstring Architecture de l’appareil sur lequel se trouve le bloc :The architecture of the device on which the block exists:

  • ARM64ARM64
  • SystèmesX86
targetOstargetOs stringstring L’une des chaînes suivantes qui spécifie la version du système d’exploitation Windows 10 sur laquelle l’application de bureau est bloquée :One of the following strings that specifies the Windows 10 OS release on which the desktop application is blocked from running:

  • Version 1709Version 1709
  • Version 1803Version 1803
deviceCountdeviceCount nombrenumber Nombre d’appareils distincts qui ont des blocs au niveau d’agrégation spécifié.The number of distinct devices that have blocks at the specified aggregation level.

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",
     "date": "2018-06-03",
     "productName": "Contoso Demo",
     "fileName": "contosodemo.exe",
     "applicationVersion": "2.2.2.0",
     "osVersion": "Windows 8.1",
     "osRelease": "Update 1",
     "market": "ZA",
     "deviceType": "All",
     "blockType": "Runtime Notification",
     "architecture": "X86",
     "targetOs": "RS4",
     "deviceCount": 120
    }
  ],
  "@nextLink": "desktop/blockdetails?applicationId=123456789&startDate=2018-01-01&endDate=2018-02-01&top=10000&skip=10000&groupby=applicationVersion,deviceType,osVersion,osRelease",
  "TotalCount": 23012
}