Obtenir des acquisitions d’applications
Utilisez cette méthode dans l’API d’analytique de la Boutique Microsoft 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.
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/appacquisitions |
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 des données d’acquisition. | Oui |
| startDate | 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 |
| endDate | 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 | 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. Par exemple, filter=market eq 'US' et gender eq 'm'. Vous pouvez spécifier les champs suivants à partir du corps de la réponse :
|
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 acquisition. La syntaxe est orderby=field [order],field [order],.... Le paramètre de champ peut être l’une des chaînes suivantes :
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. Spécifiez les champs suivants :
Les lignes de données retournées contiennent les champs spécifiés dans le paramètre groupby, ainsi que les éléments suivants :
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 requêtes 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>
Response
Response body
| Valeur | Type | Description |
|---|---|---|
| active | 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 | 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’acquisition pour la requête. |
| TotalCount | 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 | Type | Description |
|---|---|---|
| date | string | La première date 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 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 des données d’acquisition. |
| applicationName | string | Nom complet de l'application. |
| deviceType | string | L’une des chaînes suivantes qui spécifie le type d’appareil sur lequel l’acquisition s’est produite :
|
| orderName | string | Nom de l'ordre. |
| storeClient | string | Une des chaînes suivantes qui indique la version du Store où l’acquisition s’est produite :
|
| osVersion | string | Une des chaînes suivantes qui spécifie la version du système d’exploitation sur laquelle l’acquisition s’est produite :
|
| market | string | Code pays ISO 3166 du marché où l’acquisition s’est produite. |
| gender | string | Une des chaînes suivantes qui spécifie le genre de l’utilisateur qui a effectué l’acquisition :
|
| ageGroup | string | Une des chaînes suivantes qui spécifie le groupe d’âge de l’utilisateur qui a effectué l’acquisition :
|
| acquisitionType | string | Une des chaînes suivantes qui indique le type d’acquisition :
|
| acquisitionQuantity | nombre | Nombre d’acquisitions 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/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"
}