Obtenir des acquisitions d’extensions
Utilisez cette méthode dans l’API d’analyse de la Boutique Microsoft pour obtenir des données d’acquisition agrégées pour les modules complémentaires pour votre application au format JSON pendant une plage de dates donnée et d’autres filtres facultatifs. Ces informations sont également disponibles dans le rapport sur les acquisitions de modules complémentaires 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/inappacquisitions |
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
Le paramètre applicationId ou inAppProductId est requis. Pour récupérer les données d’acquisition pour tous les modules complémentaires inscrits à l’application, spécifiez le paramètre applicationId. Pour récupérer les données d’acquisition d’un module complémentaire unique, spécifiez le paramètre inAppProductId. Si vous spécifiez les deux, le paramètre applicationId est ignoré.
| Paramètre | Type | Description | Obligatoire |
|---|---|---|---|
| applicationId | string | L’ID Store de l’application pour laquelle vous souhaitez récupérer des données d’acquisition de module complémentaire. | Oui |
| inAppProductId | string | L’ID Store de l’extension 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 de l’extension à 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 de l’extension à 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. Pour plus d’informations, consultez la section Champs de filtreci-dessous. | 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 de module complémentaire. 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 |
Champs Filtrer
Le paramètre de filtre de la requête contient une ou plusieurs instructions qui filtrent les lignes dans la réponse. Chaque instruction contient un champ et une valeur associés aux opérateurs eq ou ne, et les instructions peuvent être combinées à l’aide et ou ou. Voici quelques exemples de paramètres de filtre :
- filter=market eq 'US' and gender eq 'm'
- filter=(market ne 'US') et (gender ne 'Unknown') et (gender ne 'm') et (market ne 'NO') et (ageGroup ne 'supérieur à 55' ou ageGroup ne 'inférieur à 13')
Pour connaître les champs pris en charge, consultez la table suivante. Les valeurs de chaîne doivent être entourées de guillemets simples dans le paramètre de filtre.
| Champs | Description |
|---|---|
| acquisitionType | Une des chaînes suivantes :
|
| ageGroup | Une des chaînes suivantes :
|
| storeClient | Une des chaînes suivantes :
|
| gender | Une des chaînes suivantes :
|
| market | Chaîne qui contient le code pays ISO 3166 du marché où l’acquisition s’est produite. |
| osVersion | Une des chaînes suivantes :
|
| deviceType | Une des chaînes suivantes :
|
| orderName | Chaîne qui spécifie le nom de l’ordre du code promotionnel utilisé pour acquérir le module complémentaire (cela s’applique uniquement si l’utilisateur a acquis le module complémentaire en échangeant un code promotionnel). |
Exemple de requête
Les exemples suivants illustrent plusieurs demandes d’obtention de données d’acquisition de modules complémentaires. Remplacez les valeurs inAppProductId et applicationId par l’ID Store approprié pour votre module complémentaire ou votre application.
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?inAppProductId=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/inappacquisitions?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/inappacquisitions?inAppProductId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=7/3/2015&top=100&skip=0&filter=market ne 'US' and gender ne 'Unknown' and gender ne 'm' and market ne 'NO' and ageGroup ne '>55' 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 d’extension agrégées. Pour plus d’informations sur les données de chaque objet, consultez la section des valeurs d’acquisition de module complémentaire 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 de module complémentaire pour la requête. |
| TotalCount | int | Nombre total de lignes dans le résultat des données de la requête. |
Valeurs d’acquisition de modules complémentaires
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. |
| inAppProductId | string | L’ID Store de l’extension pour laquelle vous récupérez des données d’acquisition. |
| inAppProductName | string | Nom d’affichage de l’extension. Cette valeur apparaît uniquement dans les données de réponse si le paramètre aggregationLevel est défini sur jour, sauf si vous spécifiez le champ inAppProductName dans le paramètre groupby. |
| applicationId | string | L’ID Store de l’application pour laquelle vous souhaitez récupérer des données d’acquisition de module complémentaire. |
| applicationName | string | Nom complet de l'application. |
| deviceType | string | Type d’appareil qui a terminé l’acquisition. Pour obtenir la liste des chaînes prises en charge, consultez la section champs de filtre ci-dessus. |
| orderName | string | Nom de l'ordre. |
| storeClient | string | Version du Store où l’acquisition s’est produite. Pour obtenir la liste des chaînes prises en charge, consultez la section champs de filtre ci-dessus. |
| osVersion | string | Version du système d’exploitation sur laquelle l’acquisition s’est produite. Pour obtenir la liste des chaînes prises en charge, consultez la section champs de filtre ci-dessus. |
| market | string | Code pays ISO 3166 du marché où l’acquisition s’est produite. |
| gender | string | Sexe de l’utilisateur qui a effectué l’acquisition. Pour obtenir la liste des chaînes prises en charge, consultez la section champs de filtre ci-dessus. |
| ageGroup | string | Groupe d’âge de l’utilisateur ayant effectué l’acquisition. Pour obtenir la liste des chaînes prises en charge, consultez la section champs de filtre ci-dessus. |
| acquisitionType | string | Type d’acquisition (gratuit, payant, etc.). Pour obtenir la liste des chaînes prises en charge, consultez la section champs de filtre ci-dessus. |
| acquisitionQuantity | entier | Nombre d’acquisitions qui se sont produites. |
Exemple de requête et de réponse
L’extrait de code suivant illustre 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/inappacquisitions?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>
Exemple de réponse
{
"Value": [
{
"applicationId": "9NBLGGGZ5QDR",
"inAppProductName": "Deluxe Collector's Edition",
"addonProductId": "9NBLGGAAGZDQ",
"date": "2022-07-29",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 18.12,
"purchasePriceLocalAmount": 18.12,
"purchaseTaxUSDAmount": 1.13,
"purchaseTaxLocalAmount": 1.13
},
{
"applicationId": "9NBLGGGZ5QDR",
"inAppProductName": "Episode 4",
"addonProductId": "9NAAAAAAAAAQ",
"date": "2017-01-07",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 4.147206,
"purchasePriceLocalAmount": 3.99,
"purchaseTaxUSDAmount": 0.686004,
"purchaseTaxLocalAmount": 0.66
},
{
"applicationId": "9NBLGGGZ5QDR",
"inAppProductName": "Deluxe Collector's Edition",
"addonProductId": "9NALGGGZ5QDQ",
"date": "2018-04-01",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 1.99,
"purchasePriceLocalAmount": 1.99,
"purchaseTaxUSDAmount": 0.0,
"purchaseTaxLocalAmount": 0.0
},
{
"applicationId": "9NBLGGGZ5QDR",
"inAppProductName": "Strategy Guide Episode 4",
"addonProductId": "9NBLGGGZ5QDQ",
"date": "2021-11-25",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 1.31902922876179,
"purchasePriceLocalAmount": 150.0,
"purchaseTaxUSDAmount": 0.114315866492689,
"purchaseTaxLocalAmount": 13.0
},
],
"TotalCount": 4,
"DataFreshnessTimestamp": "2022-07-29T05:54:00"
}
Rubriques connexes
- Rapport sur les acquisitions des extensions
- Accéder aux données d’analyse à l’aide des services de la Boutique Microsoft
- Obtenir les conversions d’extensions par canal
- Obtenir des acquisitions d’applications
- Obtenir les données d’entonnoir d’acquisition d’applications
- Obtenir les conversions d’applications par canal
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour