Obtenir les conversions d’applications par canal

  • Article
  • 6 minutes de lecture

Utilisez cette méthode dans l’API d’analyse du Microsoft Store pour obtenir des conversions agrégées par canal pour une application pendant une plage de dates donnée et d’autres filtres facultatifs.

  • Une conversion signifie qu’un client (connecté avec un compte Microsoft) a récemment obtenu une licence pour votre application (que vous ayez facturé de l’argent ou que vous l’ayez offerte gratuitement).
  • Le canal est la méthode par laquelle un client est arrivé à la page de référencement de votre application (par exemple, via le Store ou une campagne de promotion d’application personnalisée).

Ces informations sont également disponibles dans le rapport Acquisitions de l’Espace partenaires.

Prérequis

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

  • Si vous ne l’avez pas déjà fait, remplissez toutes les conditions préalables pour l’API d’analyse du Microsoft Store.
  • Obtenez un jeton d’accès Azure AD à utiliser dans l’en-tête de requête de 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 arrivé à expiration, 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/appchannelconversions

En-tête de requête

En-tête Type Description
Autorisation string Obligatoire. Jeton d’accès Azure AD sous la formeJeton> du porteur<.

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 conversion. Exemple d’ID Windows Store : 9WZDNCRFJ3Q8. Oui
startDate Date Date de début dans la plage de dates des données de conversion à récupérer. La valeur par défaut est 1/1/2016. Non
endDate Date Date de fin dans la plage de dates des données de conversion à récupérer. La valeur par défaut est la date actuelle. Non
top int Le nombre de lignes de données à renvoyer dans la requête. La valeur maximale et la valeur par défaut en l’absence de définition est 10000. Si la requête comporte davantage de lignes, le corps de la réponse inclut un lien sur lequel vous cliquez pour solliciter la page suivante de données. Non
skip int Le nombre de lignes à ignorer dans la requête. Utilisez ce paramètre pour parcourir de grands ensembles de données. Par exemple, indiquez top=10000 et skip=0 pour obtenir les 10000 premières lignes de données, top=10000 et skip=10000 pour obtenir les 10000 lignes suivantes, et ainsi de suite. Non
filter string Une ou plusieurs instructions qui filtrent le corps de la réponse. Chaque instruction peut utiliser les opérateurs eq ou ne ; les instructions peuvent être combinées à l’aide de and ou or. Vous pouvez spécifier les chaînes suivantes dans les instructions de filtre. Pour obtenir des descriptions, consultez la section valeurs de conversion de cet article.
  • applicationName
  • appType
  • customCampaignId
  • referrerUriDomain
  • channelType
  • storeClient
  • deviceType
  • Marché

Voici un exemple de paramètre de filtre : filter=deviceType eq 'PC'.

 Non
aggregationLevel string Indique la plage de temps pendant laquelle récupérer les données agrégées. Il peut s’agit des chaînes suivantes : day, week ou month. Par défaut, la valeur est day. Non
orderby string Instruction qui classe les valeurs de données de résultat pour chaque conversion. La syntaxe est orderby=field [order],field [order],.... Le paramètre field peut être l’une des chaînes suivantes :
  • date
  • applicationName
  • appType
  • customCampaignId
  • referrerUriDomain
  • channelType
  • storeClient
  • deviceType
  • Marché

Le paramètre order, facultatif, peut comporter les valeurs asc ou desc afin de 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 Une instruction qui applique l’agrégation des données uniquement sur les champs spécifiés. Vous pouvez spécifier les champs suivants :
  • date
  • applicationName
  • appType
  • customCampaignId
  • referrerUriDomain
  • channelType
  • storeClient
  • deviceType
  • Marché

Les lignes de données renvoyées comportent les champs spécifiés dans le paramètre groupby, ainsi que dans les paramètres suivants :

  • date
  • applicationId
  • conversionCount
  • clickCount

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2017&endDate=4/31/2017&skip=0&filter=market eq 'US'  HTTP/1.1
Authorization: Bearer <your access token>

response

Response body

Valeur Type Description
Valeur tableau Tableau d’objets qui contiennent des données de conversion agrégées pour l’application. Pour plus d’informations sur les données de chaque objet, consultez la section valeurs de conversion ci-dessous.
@nextLink string S’il existe des pages supplémentaires de données, cette chaîne comporte un URI que vous pouvez utiliser pour solliciter la page suivante de données. Par exemple, cette valeur est retournée si le paramètre supérieur de la requête est défini sur 10, mais qu’il existe plus de 10 lignes de données de conversion pour la requête.
TotalCount int Nombre total de lignes dans les résultats de la requête.

Valeurs de conversion

Les objets du tableau Value contiennent les valeurs suivantes.

Valeur Type Description
Date string Première date de la plage de dates pour les données de conversion. Si la requête spécifiait un jour précis, cette valeur correspond à la date. Si la requête était relative à une semaine, un mois ou toute autre plage de dates, cette valeur correspond à la première date de la plage de dates.
applicationId string ID Store de l’application pour laquelle vous récupérez les données de conversion.
applicationName string Nom complet de l’application pour laquelle vous récupérez des données de conversion.
appType string Type du produit pour lequel vous récupérez les données de conversion. Pour cette méthode, la seule valeur prise en charge est App.
customCampaignId string Chaîne d’ID d’une campagne de promotion d’application personnalisée associée à l’application.
referrerUriDomain string Spécifie le domaine dans lequel la liste d’applications avec l’ID de campagne de promotion d’application personnalisée a été activée.
channelType string Une des chaînes suivantes qui spécifie le canal pour la conversion :
  • CustomCampaignId
  • Stocker le trafic
  • Autres
storeClient string Version du Windows Store dans laquelle la conversion s’est produite. Actuellement, la seule valeur prise en charge est SFC.
deviceType string Une des chaînes suivantes :
  • PC
  • Téléphone
  • Console-Xbox One
  • Console-Xbox Series X
  • IoT
  • Hologrammes
  • Unknown
market string Code de pays ISO 3166 du marché où la conversion a eu lieu.
clickCount nombre Nombre de clics du client sur le lien de description de votre application.
conversionCount nombre Nombre de conversions de clients.

Exemple de requête et de réponse

Les extraits de code suivants illustrent quelques exemples de requête et de corps de réponse JSON pour ces demandes.

Exemple de demande

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=06/23/2022&endDate=07/21/2022&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>

Exemple de réponse

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "clickCount": 3089,
            "conversionCount": 14
        }
    ],
    "@nextLink": "",
    "TotalCount": 1
}

Exemple de demande

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=06/19/2022&endDate=07/21/2022&skip=0&groupby=date,applicationName,customCampaignId,referrerUriDomain,channelType,storeClient,deviceType,market&filter=market eq 'US'
HTTP/1.1
Authorization: Bearer <your access token>

Exemple de réponse

{
    "Value": [
        {
            "date": "2022-06-19",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "",
            "referrerUriDomain": "Universal Client Store",
            "channelType": "Store Traffic",
            "storeClient": "SFC",
            "deviceType": "PC",
            "market": "US",
            "clickCount": 13,
            "conversionCount": 0
        },
        {
            "date": "2022-06-20",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "",
            "referrerUriDomain": "Universal Client Store",
            "channelType": "Store Traffic",
            "storeClient": "SFC",
            "deviceType": "PC",
            "market": "US",
            "clickCount": 6,
            "conversionCount": 0
        },
        {
            "date": "2022-06-21",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "",
            "referrerUriDomain": "Universal Client Store",
            "channelType": "Store Traffic",
            "storeClient": "SFC",
            "deviceType": "PC",
            "market": "US",
            "clickCount": 4,
            "conversionCount": 0
        },
        {
            "date": "2022-06-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "",
            "referrerUriDomain": "Universal Client Store",
            "channelType": "Store Traffic",
            "storeClient": "SFC",
            "deviceType": "PC",
            "market": "US",
            "clickCount": 4,
            "conversionCount": 0
        },
    ],
    "@nextLink": "",
    "TotalCount": 4
}