Partager via

Obtenir les installations d’applications

  • Article

Utilisez cette méthode dans l’API d’analyse de la Boutique Microsoft pour obtenir des données d’installation agrégées au format JSON pour une application pendant une plage de dates donnée et d’autres filtres facultatifs. Ces informations sont également disponibles dans le rapport Acquisitions dans l’Espace 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/installs

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 Store de l’application pour laquelle vous souhaitez récupérer les données d’installation. 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 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 :

  • market
  • osVersion
  • deviceType
  • packageVersion
 Non
aggregationLevel string Spécifie l’intervalle de temps pour lequel récupérer des données agrégées. Il peut s’agir de l’une des chaînes suivantes : jour, semaine ou mois. Si aucune valeur n’est spécifiée, la valeur par défaut est jour. 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 :

  • applicationName
  • date
  • deviceType
  • market
  • osVersion
  • packageVersion
  • successfulInstallCount

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 :

  • applicationName
  • date
  • deviceType
  • market
  • osVersion
  • packageVersion

Les lignes de données retournées contiennent les champs spécifiés dans le paramètre groupby, ainsi que les éléments suivants :

  • date
  • applicationId
  • successfulInstallCount

Le paramètre groupby peut être utilisé avec le paramètre aggregationLevel. Par exemple : &groupby=ageGroup,market&aggregationLevel=week

 Non

 

Exemple de requête

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs?applicationId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&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 première date de la plage de dates pour les données d’installation. Si la demande a spécifié un jour unique, cette valeur est cette date. Si la requête a spécifié une semaine, un mois ou une autre plage de dates, cette valeur est la première date de cette plage de dates.
applicationId string ID Store de l’application pour laquelle vous récupérez les données d’installation.
applicationName string Nom complet de l'application.
deviceType string Une des chaînes suivantes qui spécifie le type d’appareil qui a terminé l’installation :

  • PC
  • Téléphone
  • Console-Xbox One
  • Console-Xbox Series X
  • IoT
  • Holographique
  • Inconnu
packageVersion string La version du package qui a été installée.
osVersion string Une des chaînes suivantes qui spécifie la version du système d’exploitation sur laquelle l’installation s’est produite :

  • Windows Phone 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Windows Phone 10
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Inconnu
market string Code pays ISO 3166 du marché où l’installation s’est produite.
successfulInstallCount nombre Nombre d’installations réussies qui se sont produites pendant le niveau d’agrégation spécifié.

Exemple de requête et de réponse

Les extraits de code suivants illustrent un exemple de corps de requête et de réponse JSON pour cette requête.

Exemple de requête

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs?applicationId=9WZDNCRFJB4P
HTTP/1.1
Authorization: Bearer <your access token>

Exemple de réponse

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "successfulInstallCount": 100053
        }
    ],
    "TotalCount": 1
}

Exemple de requête

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=06/19/2022&endDate=07/21/2022&top=10&skip=0&groupby=applicationName,date,deviceType,market,osVersion,packageVersion&orderby=date desc
HTTP/1.1
Authorization: Bearer <your access token>

Exemple de réponse

{
    "Value": [
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "AR",
            "osVersion": "Windows 10",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "AU",
            "osVersion": "Windows 10",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "BD",
            "osVersion": "Windows 10",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "BG",
            "osVersion": "Windows 11",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "BO",
            "osVersion": "Windows 10",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "BR",
            "osVersion": "Windows 10",
            "successfulInstallCount": 6
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "BR",
            "osVersion": "Windows 11",
            "successfulInstallCount": 3
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "CA",
            "osVersion": "Windows 11",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "CN",
            "osVersion": "Windows 11",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "MX",
            "osVersion": "Windows 10",
            "successfulInstallCount": 1
        }
    ],
    "TotalCount": 10
}