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 des blocs d’applications 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 les 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 ce n’est pas déjà fait, remplissez toutes les conditions préalables relatives à l’API d’analyse de la Boutique Microsoft.
- Obtenir un jeton d’accès Azure AD à utiliser dans l’en-tête de requête pour 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 expiré, 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 au format porteur<jeton>. |
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 un rapport d’analyse pour votre application de bureau dans l’Espace partenaires (tel que 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 de 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 |
| haut | int | Nombre de lignes de données à retourner dans la requête. La valeur maximale, soit la valeur par défaut, est 10000 (si cette valeur n’est pas spécifiée). S’il existe plus de lignes dans la requête, le corps de la réponse inclut un lien suivant que vous pouvez utiliser pour demander la page suivante de données. | Non |
| skip | int | Nombre de lignes à ignorer dans la requête. Utilisez ce paramètre pour parcourir des jeux de données volumineux. Par exemple, top=10000 et skip=0 récupère les 10000 premières lignes de données, top=10000 et skip=10000 récupère les 10000 lignes de données suivantes, et ainsi de suite. | Non |
| filter | string | Une ou plusieurs instructions qui filtrent les lignes dans la réponse. Chaque instruction contient un nom de champ à partir du corps de la réponse et une valeur associés aux opérateurs eq ou ne, et les instructions peuvent être combinées à l’aide et ou ou. Les valeurs de chaîne doivent être entourées de guillemets simples dans le paramètre de filtre. Vous pouvez spécifier les champs suivants à partir du corps de la réponse :
|
Non |
| orderby | string | Instruction qui trie les valeurs de données de résultat pour chaque bloc. La syntaxe est orderby=field [order],field [order],.... Le paramètre de champ peut être l’un des champs suivants du corps de la réponse :
Le paramètre d’ordre est facultatif et peut être asc ou desc pour 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 | Instruction qui applique l’agrégation de données uniquement aux champs spécifiés. Vous pouvez spécifier les champs suivants à partir du corps de la réponse :
Les lignes de données retournées contiennent les champs spécifiés dans le paramètre groupby, ainsi que les éléments suivants :
|
Non |
Exemple de requête
L’exemple suivant illustre plusieurs demandes d’obtention de données de bloc d’application de bureau. Remplacez la valeur de applicationId par l’ID du 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 |
|---|---|---|
| active | 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 de données supplémentaires, cette chaîne contient un URI que vous pouvez utiliser pour demander la page suivante des données. Par exemple, cette valeur est retournée si le paramètre supérieur de la requête est défini sur 1 0000, mais qu’il existe plus de 1 0000 lignes de données de bloc pour la requête. |
| TotalCount | int | Nombre total de lignes dans le résultat des données de la requête. |
Les éléments du tableau Valeur contiennent 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 complet de l’application bureautique comme dérivé des métadonnées de son ou 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 est en cours d’exécution :
|
| osRelease | string | L’une des chaînes suivantes qui spécifie la version du système d’exploitation ou l’anneau de vol (sous-remplissage dans la version du système d’exploitation) sur laquelle l’application de bureau est en cours d’exécution. Pour Windows 11 : Version 2110 Pour Windows 10 :
Pour Windows Server 1709 :
Pour Windows Server 2016 :
Pour Windows 8.1 :
Pour Windows 7 :
Si la version du système d’exploitation ou la boucle de distribution de versions d’évaluation est inconnue, ce champ a la valeur Inconnu. |
| market | string | Code 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 :
|
| blockType | string | Une des chaînes suivantes qui spécifie le type de bloc trouvé sur l’appareil :
|
| architecture | string | Architecture de l’appareil sur lequel le bloc existe :
|
| targetOs | string | L’une des chaînes suivantes qui spécifie la version du système d’exploitation Windows 10 ou Windows 11 sur laquelle l’application de bureau est bloquée de s’exécuter :
|
| deviceCount | nombre | Nombre d’appareils distincts qui ont des blocs au niveau d’agrégation spécifié. |
Exemple de réponse
L’exemple suivant illustre un exemple de 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
}