Obtenir les conversions d’applications par canal

Article
01/17/2024

Utilisez cette méthode dans l’API d’analyse de la Boutique Microsoft 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 obtenu une licence pour votre application (que vous ayez facturé de l’argent ou que vous l’avez proposé gratuitement).
Le canal est la méthode dans 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 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/appchannelconversions`

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 conversion. Un exemple d’ID store est 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
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 le corps de la réponse. Chaque instruction peut utiliser les opérateurs eq ou ne, et les instructions peuvent être combinées à l’aide et ou ou. 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 market Voici un exemple de paramètre de filtre : filter=deviceType eq 'PC'.	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 trie les valeurs de données de résultat pour chaque conversion. La syntaxe est orderby=field [order],field [order],.... Le paramètre de champ peut être l’une des chaînes suivantes : date applicationName appType customCampaignId referrerUriDomain channelType storeClient deviceType market 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 : date applicationName appType customCampaignId referrerUriDomain channelType storeClient deviceType market 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 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 requêtes d’obtention de données de conversion d’application. Remplacez la valeur applicationId par l’ID 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
active	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 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 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 le résultat des données de la requête.

Valeurs de conversion

Les objets 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 de conversion. 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 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 des données de conversion. Pour cette méthode, la seule valeur prise en charge est App.
customCampaignId	string	Chaîne d’ID pour une campagne de promotion d’application personnalisée associée à l’application.
referrerUriDomain	string	Spécifie le domaine dans lequel la liste des applications avec l’ID de campagne de promotion d’application personnalisé a été activée.
channelType	string	Une des chaînes suivantes qui spécifie le canal pour la conversion : CustomCampaignId Trafic du Store Other
storeClient	string	Version du Store où 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 Holographique Inconnu
market	string	Code pays ISO 3166 du marché où la conversion s’est produite.
clickCount	nombre	Nombre de clics clients sur le lien de référencement de votre application.
conversionCount	nombre	Nombre de conversions de clients.

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/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 requête

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
}

Partager via

Obtenir les conversions d’applications par canal

Prérequis

Requête

Syntaxe de la requête

En-tête de requête

Paramètres de la demande

Exemple de requête

Response

Response body

Valeurs de conversion

Exemple de requête et de réponse

Exemple de requête

Exemple de réponse

Exemple de requête

Exemple de réponse

Commentaires

Ressources supplémentaires

Partager via

Obtenir les conversions d’applications par canal

Prérequis

Requête

Syntaxe de la requête

En-tête de requête

Paramètres de la demande

Exemple de requête

Response

Response body

Valeurs de conversion

Exemple de requête et de réponse

Exemple de requête

Exemple de réponse

Exemple de requête

Exemple de réponse

Rubriques connexes

Commentaires

Ressources supplémentaires