Obtenir les installations d’applications de bureau
Utilisez cette URI REST pour obtenir des données d’installation agrégées au format JSON pour une application de bureau que vous avez ajoutée au Programme d’application de bureau Windows. Cette URI vous permet d’obtenir des données d’installation pendant une période de dates donnée et d’autres filtres facultatifs. Ces informations sont également disponibles dans le rapport d’installations pour les applications de bureau dans le Centre des partenaires.
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/installbasedaily |
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 | L’ID du produit de l’application de bureau pour laquelle vous souhaitez récupérer les données d’installation. Pour obtenir l’ID du produit d’une application de bureau, ouvrez n’importe quel rapport d’analyse pour votre application de bureau dans le Centre des partenaires (tel que le rapport d’installations) et récupérez l’ID du produit à partir de l’URL en survolant votre souris sur le lien pour révéler les détails. | Oui |
| startDate | date | Date de début dans la plage de dates des données d’installation à 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 d’installation à 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 commande les valeurs de données de résultat pour chaque installation. 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 démontre plusieurs requêtes pour obtenir des données d’installation d’une 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/installbasedaily?applicationId=1234567890&startDate=2018-01-01&endDate=2018-02-01&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/installbasedaily?applicationId=1234567890&startDate=2018-01-01&endDate=2018-02-01&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 d’installation agrégées. 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 10000, mais qu’il existe plus de 10000 lignes de données d’installation 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 |
|---|---|---|
| date | string | La date associée à la valeur de base d’installation. |
| applicationId | string | L’ID du produit de l’application de bureau pour laquelle vous avez récupéré les données d’installation. |
| productName | string | Nom complet de l’application bureautique comme dérivé des métadonnées de son ou ses exécutables associés. |
| applicationVersion | string | La version de l’exécutable de l’application installée. |
| deviceType | string | L’une des chaînes suivantes qui spécifie le type de périphérique sur lequel l’application de bureau est installée :
|
| market | string | Le code de pays ISO 3166 du marché dans lequel l’application de bureau est installée. |
| osVersion | string | L’une des chaînes suivantes qui spécifie la version du système d’exploitation sur lequel l’application de bureau est installée :
|
| osRelease | string | L’une des chaînes suivantes qui spécifie la version du système d’exploitation ou l’anneau de déploiement (en tant que sous-population au sein de la version du système d’exploitation) sur lequel l’application de bureau est installée. 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. |
| installBase | nombre | Le nombre de périphériques distincts sur lesquels le produit a été installé 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": [
{
"date": "2018-01-24",
"applicationId": "123456789",
"productName": "Contoso Demo",
"applicationVersion": "1.0.0.0",
"deviceType": "PC",
"market": "All",
"osVersion": "Windows 10",
"osRelease": "Version 1709",
"installBase": 348218.0
}
],
"@nextLink": "desktop/installbasedaily?applicationId=123456789&startDate=2018-01-01&endDate=2018-02-01&top=10000&skip=10000&groupby=applicationVersion,deviceType,osVersion,osRelease",
"TotalCount": 23012
}