Obtenir les conversions d’applications par canalGet app conversions by channel

Utilisez cette méthode dans l’API Microsoft Store Analytics pour obtenir des conversions d’agrégats par canal pour une application pendant une plage de dates donnée et d’autres filtres facultatifs.Use this method in the Microsoft Store analytics API to get aggregate conversions by channel for an application during a given date range and other optional filters.

  • Une conversion signifie qu’un client (connecté à l’aide d’un compte Microsoft) a récemment obtenu une licence pour votre application (que vous ayez ou non facturé un argent).A conversion means that a customer (signed in with a Microsoft account) has newly obtained a license to your app (whether you charged money or you've offered it for free).
  • Le canal est la méthode dans laquelle un client est arrivé sur la page de liste de votre application (par exemple, via la campagne de promotion de la boutique ou d’une application personnalisée).The channel is the method in which a customer arrived at your app's listing page (for example, via the Store or a custom app promotion campaign).

Ces informations sont également disponibles dans le rapport acquisitions de l’espace partenaires.This information is also available in the Acquisitions report in Partner Center.

PrérequisPrerequisites

Pour utiliser cette méthode, vous devez d’abord effectuer les opérations suivantes :To use this method, you need to first do the following:

  • Si vous ne l’avez pas déjà fait, renseignez toutes les conditions préalables pour l’API Microsoft Store Analytics.If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
  • Obtenez un jeton d’accès Azure AD à utiliser dans l’en-tête de requête de cette méthode.Obtain an Azure AD access token to use in the request header for this method. 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.After you obtain an access token, you have 60 minutes to use it before it expires. Une fois le jeton arrivé à expiration, vous pouvez en obtenir un nouveau.After the token expires, you can obtain a new one.

RequêteRequest

Syntaxe de la requêteRequest syntax

MéthodeMethod URI de demandeRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appchannelconversions

En-tête de requêteRequest header

En-têteHeader TypeType DescriptionDescription
AutorisationAuthorization stringstring Obligatoire.Required. Jeton d’accès Azure AD sous la forme Bearer <jeton>.The Azure AD access token in the form Bearer <token>.

Paramètres de la demandeRequest parameters

ParamètreParameter TypeType DescriptionDescription ObligatoireRequired
applicationIdapplicationId stringstring ID de stockage de l’application dont vous souhaitez récupérer les données de conversion.The Store ID of the app for which you want to retrieve conversion data. Exemple d’ID Windows Store : 9WZDNCRFJ3Q8.An example Store ID is 9WZDNCRFJ3Q8. OuiYes
startDatestartDate Datedate Date de début dans la plage de dates des données de conversion à récupérer.The start date in the date range of conversion data to retrieve. La valeur par défaut est 1/1/2016.The default is 1/1/2016. NonNo
endDateendDate Datedate Date de fin dans la plage de dates des données de conversion à récupérer.The end date in the date range of conversion data to retrieve. La valeur par défaut est la date actuelle.The default is the current date. NonNo
toptop intint Le nombre de lignes de données à renvoyer dans la requête.The number of rows of data to return in the request. La valeur maximale et la valeur par défaut en l’absence de définition est 10000.The maximum value and the default value if not specified is 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.If there are more rows in the query, the response body includes a next link that you can use to request the next page of data. NonNo
skipskip intint Le nombre de lignes à ignorer dans la requête.The number of rows to skip in the query. Utilisez ce paramètre pour parcourir de grands ensembles de données.Use this parameter to page through large data sets. 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.For example, top=10000 and skip=0 retrieves the first 10000 rows of data, top=10000 and skip=10000 retrieves the next 10000 rows of data, and so on. NonNo
Filterfilter stringstring Une ou plusieurs instructions qui filtrent le corps de la réponse.One or more statements that filter the response body. Chaque instruction peut utiliser les opérateurs eq ou ne ; les instructions peuvent être combinées à l’aide de and ou or.Each statement can use the eq or ne operators, and statements can be combined using and or or. Vous pouvez spécifier les chaînes suivantes dans les instructions de filtre.You can specify the following strings in the filter statements. Pour obtenir des descriptions, consultez la section valeurs de conversion dans cet article.For descriptions, see the conversion values section in this article.
  • applicationNameapplicationName
  • appTypeappType
  • customCampaignIdcustomCampaignId
  • referrerUriDomainreferrerUriDomain
  • channelTypechannelType
  • storeClientstoreClient
  • deviceTypedeviceType
  • négocimarket

Voici un exemple de paramètre de filtre : Filter = DEVICETYPE EQ’PC'.Here is an example filter parameter: filter=deviceType eq 'PC'.

NonNo
aggregationLevelaggregationLevel stringstring Indique la plage de temps pendant laquelle récupérer les données agrégées.Specifies the time range for which to retrieve aggregate data. Il peut s’agit des chaînes suivantes : day, week ou month.Can be one of the following strings: day, week, or month. Par défaut, la valeur est day.If unspecified, the default is day. NonNo
orderbyorderby stringstring Instruction qui classe les valeurs de données de résultat pour chaque conversion.A statement that orders the result data values for each conversion. La syntaxe est orderby = Field [Order], champ [Order],.... Le paramètre Field peut être l’une des chaînes suivantes :The syntax is orderby=field [order],field [order],.... The field parameter can be one of the following strings:
  • datedate
  • applicationNameapplicationName
  • appTypeappType
  • customCampaignIdcustomCampaignId
  • referrerUriDomainreferrerUriDomain
  • channelTypechannelType
  • storeClientstoreClient
  • deviceTypedeviceType
  • négocimarket

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.The order parameter is optional, and can be asc or desc to specify ascending or descending order for each field. La valeur par défaut est ASC.The default is asc.

Voici un exemple de chaîne orderby : orderby = date, MarketHere is an example orderby string: orderby=date,market

NonNo
groupbygroupby stringstring Une instruction qui applique l’agrégation des données uniquement sur les champs spécifiés.A statement that applies data aggregation only to the specified fields. Vous pouvez spécifier les champs suivants :You can specify the following fields:
  • datedate
  • applicationNameapplicationName
  • appTypeappType
  • customCampaignIdcustomCampaignId
  • referrerUriDomainreferrerUriDomain
  • channelTypechannelType
  • storeClientstoreClient
  • deviceTypedeviceType
  • négocimarket

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 :The returned data rows will contain the fields specified in the groupby parameter as well as the following:

  • datedate
  • applicationIdapplicationId
  • conversionCountconversionCount
  • clickCountclickCount

Le paramètre groupby peut être utilisé avec le paramètre aggregationLevel.The groupby parameter can be used with the aggregationLevel parameter. Par exemple : GroupBy = ageGroup, Market & aggregationLevel = weekFor example: groupby=ageGroup,market&aggregationLevel=week

NonNo

Exemple de requêteRequest example

L’exemple suivant illustre plusieurs demandes d’obtention de données de conversion d’application.The following example demonstrates several requests for getting app conversion data. Remplacez la valeur applicationId par l’ID Windows Store de votre application.Replace the applicationId value with the Store ID for your app.

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>

responseResponse

Response bodyResponse body

ValeurValue TypeType DescriptionDescription
ValeurValue tableauarray Tableau d’objets qui contient les données de conversion d’agrégation pour l’application.An array of objects that contain aggregate conversion data for the app. Pour plus d’informations sur les données de chaque objet, consultez la section conversion des valeurs ci-dessous.For more information about the data in each object, see the conversion values section below.
@nextLink stringstring 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.If there are additional pages of data, this string contains a URI that you can use to request the next page of data. Par exemple, cette valeur est retournée si le paramètre supérieur de la requête a la valeur 10, mais qu’il y a plus de 10 lignes de données de conversion pour la requête.For example, this value is returned if the top parameter of the request is set to 10 but there are more than 10 rows of conversion data for the query.
TotalCountTotalCount intint Nombre total de lignes dans les résultats de la requête.The total number of rows in the data result for the query.

Valeurs de conversionConversion values

Les objets du tableau de valeurs contiennent les valeurs suivantes.Objects in the Value array contain the following values.

ValeurValue TypeType DescriptionDescription
Datedate stringstring Première date dans la plage de dates pour les données de conversion.The first date in the date range for the conversion data. Si la requête spécifiait un jour précis, cette valeur correspond à la date.If the request specified a single day, this value is that 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.If the request specified a week, month, or other date range, this value is the first date in that date range.
applicationIdapplicationId stringstring ID de stockage de l’application pour laquelle vous extrayez des données de conversion.The Store ID of the app for which you are retrieving conversion data.
applicationNameapplicationName stringstring Nom complet de l’application pour laquelle vous extrayez des données de conversion.The display name of the app for which you are retrieving conversion data.
appTypeappType stringstring Type du produit pour lequel vous extrayez des données de conversion.The type of the product for which you are retrieving conversion data. Pour cette méthode, la seule valeur prise en charge est application.For this method, the only supported value is App.
customCampaignIdcustomCampaignId stringstring Chaîne d’ID pour une campagne de promotion d’application personnalisée qui est associée à l’application.The ID string for a custom app promotion campaign that is associated with the app.
referrerUriDomainreferrerUriDomain stringstring 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.Specifies the domain where the app listing with the custom app promotion campaign ID was activated.
channelTypechannelType stringstring L’une des chaînes suivantes qui spécifient le canal pour la conversion :One of the following strings that specifies the channel for the conversion:
  • CustomCampaignIdCustomCampaignId
  • Stocker le traficStore Traffic
  • AutreOther
storeClientstoreClient stringstring Version du magasin dans lequel la conversion s’est produite.The version of the Store where the conversion occurred. Actuellement, la seule valeur prise en charge est SFC.Currently, the only supported value is SFC.
deviceTypedeviceType stringstring Une des chaînes suivantes :One of the following strings:
  • PCPC
  • NumérosPhone
  • Console-Xbox OneConsole-Xbox One
  • Console-série Xbox XConsole-Xbox Series X
  • IoTIoT
  • HologrammesHolographic
  • UnknownUnknown
marketmarket stringstring Code du pays ISO 3166 du marché où la conversion s’est produite.The ISO 3166 country code of the market where the conversion occurred.
clickCountclickCount nombrenumber Le nombre de clics du client sur le lien de votre liste d’applications.The number of customer clicks on your app listing link.
conversionCountconversionCount nombrenumber Nombre de conversions client.The number of customer conversions.

Exemple de réponseResponse example

L’exemple suivant représente un corps de réponse JSON pour cette requête.The following example demonstrates an example JSON response body for this request.

{
  "Value": [
    {
      "date": "2016-01-01",
      "applicationId": "9NBLGGGZ5QDR",
      "applicationName": "Contoso App",
      "appType": "App",
      "customCampaignId": "",
      "referrerUriDomain": "Universal Client Store",
      "channelType": "Store Traffic",
      "storeClient": "SFC",
      "deviceType": "PC",
      "market": "US",
      "clickCount": 7,
      "conversionCount": 0
    }
  ],
  "@nextLink": null,
  "TotalCount": 1
}