Partager via


Obtenir des acquisitions d’applications

Utilisez cette méthode dans l’API d’analytique du Microsoft Store pour obtenir des données d’acquisition 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.

Conditions préalables

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

  • Si vous ne l’avez pas déjà fait, remplissez tous les prérequis pour l’API d’analytique du Microsoft Store.
  • Obtenez 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 la requête
OBTENIR https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions

En-tête de requête

En-tête de page Catégorie Descriptif
Autorisation ficelle Obligatoire. Le jeton d’accès Azure AD sous la forme Bearer<token>.

Paramètres de la demande

Paramètre Catégorie Descriptif Obligatoire
applicationId ficelle L’ID Store de l’application pour laquelle vous souhaitez récupérer des données d’acquisition. Oui
date de début date Date de début dans la plage de dates des données d’acquisition à récupérer. La valeur par défaut est la date actuelle. Non
date de fin date Date de fin dans la plage de dates des données d’acquisition à récupérer. La valeur par défaut est la date actuelle. Non
Haut de page Int Nombre de lignes de données à retourner dans la requête. La valeur maximale et la valeur par défaut si elle n’est pas spécifiée est 1 0000. 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
passer 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 1 000 premières lignes de données, top=10000 et skip=10000 récupère les 1 0000 lignes de données suivantes, et ainsi de suite. Non
Filter ficelle 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 . Par exemple, filter=market eq 'US' et gender eq 'm'.

Vous pouvez spécifier les champs suivants à partir du corps de la réponse :

  • type d'acquisition
  • groupe d'âge
  • storeClient
  • sexe
  • marché
  • osVersion
  • type d'appareil
  • orderName
Non
niveau d'agrégation ficelle 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
classer par ficelle Déclaration qui spécifie les valeurs de données de résultat pour chaque acquisition. La syntaxe est orderby=field [order],field [order],.... Le paramètre de champ peut être l’une des chaînes suivantes :
  • date
  • type d'acquisition
  • groupe d'âge
  • storeClient
  • sexe
  • marché
  • osVersion
  • type d'appareil
  • orderName

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
grouppar ficelle Instruction qui applique l’agrégation de données uniquement aux champs spécifiés. Vous pouvez spécifier les champs suivants :
  • date
  • nomapplication
  • type d'acquisition
  • groupe d'âge
  • storeClient
  • sexe
  • marché
  • osVersion
  • type d'appareil
  • orderName

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
  • quantité d'acquisition

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’acquisition d’application. Remplacez la valeur applicationId par l’ID store de votre application.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?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/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and gender eq 'm'  HTTP/1.1
Authorization: Bearer <your access token>

Réponse

Corps de réponse

Valeur Catégorie Descriptif
Valeur tableau Tableau d’objets qui contiennent des données d’acquisition agrégées pour l’application. Pour plus d’informations sur les données de chaque objet, consultez la section valeurs d’acquisition ci-dessous.
@nextLink ficelle 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 premier de la requête est défini sur 1 0000, mais qu’il y a plus de 1 000 lignes de données d’acquisition pour la requête.
NombreTotal Int Nombre total de lignes dans le résultat des données de la requête.

Valeurs d’acquisition

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

Valeur Catégorie Descriptif
date ficelle La date de début de la plage de dates pour les données d'acquisition. Si la demande a spécifié un jour unique, cette valeur est cette date. Si la demande 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 ficelle ID Store de l’application pour laquelle vous récupérez des données d’acquisition.
Nom de l'application ficelle Nom d'affichage de l'application.
type de dispositif ficelle L’une des chaînes suivantes qui spécifie le type d’appareil sur lequel l’acquisition s’est produite :
  • PC
  • Téléphone
  • Console-Xbox Un
  • Console-Xbox Série X
  • IdO
  • Holographique
  • Inconnu
nomDeCommande ficelle Nom de l’ordre.
storeClient ficelle Une des chaînes de caractères suivantes indiquant la version du Store où l’acquisition s’est produite :
  • Windows Phone Store (client)
  • Microsoft Store (client) (ou Windows Store (client) si vous interrogez des données avant le 23 mars 2018)
  • Microsoft Store (web) (ou Windows Store (web) si vous interrogez des données avant le 23 mars 2018)
  • Achat en volume par les organisations
  • Autres
osVersion ficelle Une des chaînes suivantes qui spécifie la version du système d’exploitation sur laquelle l’acquisition 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
marché ficelle Code pays ISO 3166 du marché où l’acquisition s’est produite.
sexe ficelle Une des valeurs suivantes spécifiant le genre de l’utilisateur qui a effectué l’acquisition :
  • m
  • f
  • Inconnu
tranche d'âge ficelle Une des chaînes suivantes qui spécifie le groupe d’âge de l’utilisateur qui a effectué l’acquisition :
  • inférieur à 13
  • 13-17
  • 18-24
  • 25-34
  • 35-44
  • 44-55
  • supérieur à 55
  • Inconnu
type d'acquisition ficelle Une des chaînes suivantes qui indique le type d’acquisition :
  • Gratuit
  • Essai
  • Payé
  • Code promotionnel
  • Iap
  • Abonnement Iap
  • Audience privée
  • Précommande
  • Xbox Game Pass (ou Game Pass si vous interrogez des données datant d’avant le 23 mars 2018)
  • Disque
  • Code prépayé
quantitéAcquisition nombre Nombre d’acquisitions qui se sont produites pendant le niveau d’agrégation spécifié.

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

Exemple de réponse

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "date": "2022-07-29",
            "acquisitionQuantity": 7,
            "purchasePriceUSDAmount": 0.0,
            "purchasePriceLocalAmount": 0.0,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
  ],
  "TotalCount": 1,
  "DataFreshnessTimestamp": "2022-07-29T08:42:00"
}

Exemple de requête

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=8/1/2021&endDate=12/21/2021&skip=0&filter=market&groupby=date,applicationName,acquisitionType,ageGroup,storeClient,gender,market,osVersion,deviceType  HTTP/1.1
Authorization: Bearer <your access token>

Exemple de réponse

	{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "acquisitionType": "Free",
            "storeClient": "Microsoft Store (client)",
            "gender": "f",
            "market": "TW",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "date": "2021-08-01",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 0.0,
            "purchasePriceLocalAmount": 0.0,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "acquisitionType": "Free",
            "storeClient": "Microsoft Store (client)",
            "gender": "Unknown",
            "market": "BR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "date": "2021-08-01",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 0.0,
            "purchasePriceLocalAmount": 0.0,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
      ],  
  "TotalCount": 2,
  "DataFreshnessTimestamp": "2022-07-29T08:42:00"
 }