Partager via

Obtenir l’utilisation mensuelle des applications

  • Article

Utilisez cette méthode dans l’API d’analytique de la Boutique Microsoft pour obtenir des données d’utilisation agrégées (sans le mode multijoueur Xbox) au format JSON pour une application pendant une plage de dates donnée (90 derniers jours uniquement) et d’autres filtres facultatifs. Ces informations sont également disponibles dans le rapport Utilisation dans l’Espace partenaires.

Les données de télémétrie pour les applications PWA basées sur Anaheim sont collectées au niveau de l’appareil. Ainsi, les métriques liées aux utilisateurs ne seront pas disponibles pour ces produits. Pour plus d’informations sur la validité des champs, reportez-vous à la section Valeurs d’utilisation ci-dessous.

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

Method URI de demande
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/usagemonthly

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 de révision. Oui
startDate date Date de début dans la plage de dates des données de révision à 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 de révision à 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
  • deviceType
  • packageVersion
 Non
orderby string Instruction qui commande les valeurs de données de résultat. La syntaxe est orderby=field [order],field [order],.... Le paramètre de champ peut être l’une des chaînes suivantes :
  • date
  • applicationId
  • applicationName
  • market
  • packageVersion
  • deviceType
  • subscriptionName
  • monthlySessionCount
  • engagementDurationMinutes
  • monthlyActiveUsers
  • monthlyActiveDevices
  • monthlyNewUsers
  • averageDailyActiveUsers
  • averageDailyActiveDevices
  • monthlyNewDevices

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
  • subscriptionName
  • deviceType
  • packageVersion
  • market
  • date

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

  • applicationId
  • subscriptionName
  • monthlySessionCount
  • engagementDurationMinutes
  • monthlyActiveUsers
  • monthlyActiveDevices
  • monthlyNewUsers
  • averageDailyActiveUsers
  • averageDailyActiveDevices
  • monthlyNewDevices

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 une demande d’obtention de données d’utilisation d’application mensuelles. Remplacez la valeur applicationId par l’ID Store de votre application.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/usagemonthly?applicationId=XXXXXXXXXXXX&startDate=2018-06-01&endDate=2018-07-01 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’utilisation 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 de révision pour la requête.
TotalCount int Nombre total de lignes dans le résultat des données de la requête.

 

Valeurs d’utilisation

Les éléments du tableau Valeur contiennent les valeurs suivantes.

Valeur Type Description Disponibilité UWP Disponibilité PWA basée sur Anaheim Disponibilité Xbox
date string La première date de la plage de dates pour les données d’utilisation. 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. Oui Oui Oui
applicationId string ID Store de l’application pour laquelle vous récupérez des données d’utilisation. Oui Oui Oui
applicationName string Nom complet de l'application. Oui Oui Oui
market string Code pays ISO 3166 du marché où le client a utilisé votre application. Oui Oui Oui
packageVersion string Version du package où l’utilisation s’est produite. Oui Oui Non
deviceType string Une des chaînes suivantes qui spécifie le type d’appareil où l’utilisation s’est produite :
  • PC
  • Téléphone
  • Console-Xbox One
  • Console-Xbox Series X
  • Tablette
  • IoT
  • Serveur
  • Holographique
  • Unknown
 Oui Oui Oui
subscriptionName string Indique si l’utilisation était via Xbox Game Pass. Oui No Non
monthlySessionCount long Nombre de sessions utilisateur au cours du mois en cours. Oui Oui Oui
engagementDurationMinutes double Minutes pendant lesquelles les utilisateurs utilisent activement votre application en fonction d’une période distincte, en commençant par le lancement de l’application (début du processus) et en se terminant lorsqu’elle se termine (fin du processus) ou après une période d’inactivité. Oui Oui Oui
monthlyActiveUsers long Nombre de clients utilisant l’application ce mois-ci. Oui No Oui
monthlyActiveDevices long Nombre d’appareils exécutant votre application pendant une période distincte, en commençant quand l’application démarre (début du processus) et se termine lorsqu’elle se termine (fin du processus) ou après une période d’inactivité. Oui Oui Oui
monthlyNewUsers long Nombre de clients qui ont utilisé votre application pour la première fois ce mois-ci. Oui No Oui
averageDailyActiveUsers double Nombre moyen de clients utilisant l’application quotidiennement. Oui No Oui
averageDailyActiveDevices double Nombre moyen d’appareils utilisés pour interagir avec votre application par tous les utilisateurs quotidiennement. Oui Oui Oui
mensuelNewDevices long Nombre d’appareils qui ont utilisé l’application pour la première fois au cours de ce mois-ci. Non Oui Non

Remarque

Si un champ n’est pas valide pour un produit spécifique, la valeur pour ces champs est envoyée sous la forme 0 ou null dans la réponse. Le calcul des nouveaux utilisateurs et nouveaux appareils est effectué avec la fenêtre propagée de 3 ans, c’est-à-dire si un utilisateur/appareil n’utilise pas l’application pendant 3 ans et plus, il sera traité comme un nouvel utilisateur/appareil après 3 ans.

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/usagemonthly?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>

Exemple de réponse

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "deviceType": "All",
            "packageVersion": "All",
            "market": "All",
            "engagementDurationMinutes": 2828568.3,
            "monthlyActiveUsers": 165249,
            "monthlyActiveDevices": 165753,
            "monthlyNewUsers": 95787,
            "monthlySessionCount": 314263,
            "averageDailyActiveUsers": 192.506111111111,
            "averageDailyActiveDevices": 191.199722222222,
            "monthlyNewDevices": 0
        }
    ],
    "TotalCount": 1
}

Exemple de requête

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/usagemonthly?applicationId=9NBLGGGZ5QDR&startDate=2022-06-01&endDate=2022-07-01&groupby=applicationName,subscriptionName,deviceType,packageVersion,market,date&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>

Exemple de réponse

{
    "Value": [
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "1.0.0.4957",
            "market": "JP",
            "engagementDurationMinutes": 0.3,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "1.0.0.4957",
            "market": "MX",
            "engagementDurationMinutes": 2.7,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "1.0.0.4957",
            "market": "Unknown",
            "engagementDurationMinutes": 0.1,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "1.0.0.4957",
            "market": "US",
            "engagementDurationMinutes": 0.2,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AE",
            "engagementDurationMinutes": 3.2,
            "monthlyActiveUsers": 2,
            "monthlyActiveDevices": 2,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 3,
            "averageDailyActiveUsers": 0.07,
            "averageDailyActiveDevices": 0.07,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AO",
            "engagementDurationMinutes": 1.2,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AR",
            "engagementDurationMinutes": 574.7,
            "monthlyActiveUsers": 39,
            "monthlyActiveDevices": 39,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 53,
            "averageDailyActiveUsers": 1.43,
            "averageDailyActiveDevices": 1.43,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AT",
            "engagementDurationMinutes": 5.3,
            "monthlyActiveUsers": 4,
            "monthlyActiveDevices": 4,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 9,
            "averageDailyActiveUsers": 0.17,
            "averageDailyActiveDevices": 0.17,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AU",
            "engagementDurationMinutes": 434.7,
            "monthlyActiveUsers": 22,
            "monthlyActiveDevices": 22,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 36,
            "averageDailyActiveUsers": 0.9,
            "averageDailyActiveDevices": 0.9,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AZ",
            "engagementDurationMinutes": 13.5,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        }
    ],
    "TotalCount": 10
}