Obtenir des informations concernant les blocs de mise à niveau pour votre application de bureau

Utilisez cet URI REST pour obtenir des détails sur les appareils Windows 10 et Windows 11 sur lesquels un exécutable spécifique dans votre application de bureau bloque l’exécution d’une mise à niveau Windows 10 ou Windows 11. Vous pouvez utiliser cet URI uniquement pour les applications de bureau que vous avez ajoutées au programme Application de bureau Windows. Ces informations sont également disponibles dans le rapport Blocs d’application pour les applications de bureau dans l’Espace partenaires.

Cet URI est similaire à Obtenir des blocs de mise à niveau pour votre application de bureau, mais il retourne des informations de bloc d’appareil pour un exécutable spécifique dans votre application de bureau.

Prérequis

Pour utiliser cette méthode, vous devez d’abord effectuer les opérations suivantes :

  • Si vous ne l’avez pas déjà fait, remplissez toutes les conditions préalables pour l’API d’analyse du Microsoft Store.
  • Obtenez un jeton d’accès Azure AD à utiliser dans l’en-tête de requête de cette méthode. 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. Une fois le jeton arrivé à expiration, vous pouvez en obtenir un nouveau.

Requête

Syntaxe de la requête

Méthode URI de demande
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockdetails

En-tête de requête

En-tête Type Description
Autorisation string Obligatoire. Jeton d’accès Azure AD sous la formeJeton> du porteur<.

Paramètres de la demande

Paramètre Type Description Obligatoire
applicationId string ID de produit de l’application de bureau pour laquelle vous souhaitez récupérer des données de bloc. Pour obtenir l’ID de produit d’une application de bureau, ouvrez n’importe quel rapport d’analytique pour votre application de bureau dans l’Espace partenaires (par exemple, le rapport Blocs) et récupérez l’ID de produit à partir de l’URL. Oui
fileName string Nom de l’exécutable bloqué
startDate Date Date de début dans la plage de dates des données de bloc à récupérer. La valeur par défaut est 90 jours avant la date actuelle. Non
endDate Date Date de fin dans la plage de dates des données de bloc à récupérer. La valeur par défaut est la date actuelle. Non
top int Le nombre de lignes de données à renvoyer dans la requête. La valeur maximale et la valeur par défaut en l’absence de définition est 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. Non
skip int Le nombre de lignes à ignorer dans la requête. Utilisez ce paramètre pour parcourir de grands ensembles de données. 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. Non
filter string Une ou plusieurs instructions qui filtrent les lignes de la réponse. Chaque instruction contient un nom de champ à partir du corps de la réponse et de la valeur associés aux opérateurs eq ou ne, et les instructions peuvent être combinées à l’aide de et ou . Les valeurs de chaîne doivent être entourées par des guillemets dans le paramètre filter. Vous pouvez spécifier les champs suivants à partir du corps de la réponse :

  • applicationVersion
  • architecture
  • blockType
  • deviceType
  • Marché
  • osRelease
  • osVersion
  • Productname
  • targetOs
Non
orderby string Instruction qui commande les valeurs de données de résultat pour chaque bloc. La syntaxe est orderby=field [order],field [order],.... Le paramètre field peut être l’un des champs suivants du corps de la réponse :

  • applicationVersion
  • architecture
  • blockType
  • date
  • deviceType
  • Marché
  • osRelease
  • osVersion
  • Productname
  • targetOs
  • deviceCount

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. La valeur par défaut est asc.

Voici un exemple de chaîne orderby : orderby=date,market

Non
groupby string Une instruction qui applique l’agrégation des données uniquement sur les champs spécifiés. Vous pouvez spécifier les champs suivants à partir du corps de la réponse :

  • applicationVersion
  • architecture
  • blockType
  • deviceType
  • Marché
  • osRelease
  • osVersion
  • targetOs

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 :

  • applicationId
  • date
  • Productname
  • deviceCount

Non

Exemple de requête

L’exemple suivant illustre plusieurs demandes d’obtention de données de blocs d’application de bureau. Remplacez la valeur applicationId par l’ID de produit de votre application de bureau.

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>

response

Response body

Valeur Type Description
Valeur tableau Tableau d’objets qui contiennent des données de bloc d’agrégation. Pour plus d’informations sur les données de chaque objet, consultez le tableau suivant.
@nextLink string 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. Par exemple, cette valeur est retournée si le paramètre supérieur de la requête est défini sur 10000, mais qu’il existe plus de 10 000 lignes de données de bloc pour la requête.
TotalCount int Nombre total de lignes dans les résultats de la requête.

Les éléments du tableau Value comportent les valeurs suivantes :

Valeur Type Description
applicationId string ID de produit de l’application de bureau pour laquelle vous avez récupéré des données de bloc.
Date string Date associée à la valeur d’accès au bloc.
ProductName string Nom d’affichage de l’application de bureau dérivé des métadonnées de ses exécutables associés.
fileName string Exécutable qui a été bloqué.
applicationVersion string Version de l’exécutable de l’application qui a été bloquée.
osVersion string Une des chaînes suivantes qui spécifie la version du système d’exploitation sur laquelle l’application de bureau s’exécute actuellement :

  • Windows 7
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Windows Server 2016
  • Windows Server 1709
  • Unknown
osRelease string L’une des chaînes suivantes qui spécifie la version du système d’exploitation ou l’anneau de vol (sous-population dans la version du système d’exploitation) sur laquelle l’application de bureau s’exécute actuellement.

Pour Windows 11 : Version 2110

Pour Windows 10 :

  • Version 1507
  • Version 1511
  • Version 1607
  • Version 1703
  • Version 1709
  • Version préliminaire
  • Insider Fast
  • Insider Slow

Pour Windows Server 1709 :

  • RTM

Pour Windows Server 2016 :

  • Version 1607

Pour Windows 8.1 :

  • Update 1

Pour Windows 7 :

  • Service Pack 1

Si la version du système d’exploitation ou l’anneau de version d’évaluation est inconnue, ce champ a la valeur Inconnu.

market string Code de pays ISO 3166 du marché dans lequel l’application de bureau est bloquée.
deviceType string Une des chaînes suivantes qui spécifie le type d’appareil sur lequel l’application de bureau est bloquée :

  • PC
  • Serveur
  • Tablette
  • Unknown
blockType string L’une des chaînes suivantes qui spécifie le type de bloc trouvé sur l’appareil :

  • Sédiment potentiel
  • Sédiment temporaire
  • Notification d’exécution

Pour plus d’informations sur ces types de blocs et sur leur signification pour les développeurs et les utilisateurs, consultez la description du rapport Blocs d’application.
architecture string Architecture de l’appareil sur lequel le bloc existe :

  • ARM64
  • X86
targetOs string L’une des chaînes suivantes qui spécifie la version Windows 10 ou Windows 11 système d’exploitation sur laquelle l’exécution de l’application de bureau est bloquée :

  • Version 1709
  • Version 1803
deviceCount nombre Nombre d’appareils distincts qui ont des blocs au niveau d’agrégation spécifié.

Exemple de réponse

L’exemple suivant représente un corps de réponse JSON pour cette requête.

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