Obtenir les installations d’applicationsGet app installs

Utilisez cette méthode dans l’API Microsoft Store Analytics pour obtenir des données d’installation agrégées au format JSON 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 install data in JSON format for an application during a given date range and other optional filters. 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/installs

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 pour laquelle vous souhaitez récupérer les données d’installation.The Store ID of the app for which you want to retrieve install data. OuiYes
startDatestartDate Datedate Date de début dans la plage de dates des données d’installation à récupérer.The start date in the date range of install data to retrieve. La valeur par défaut est la date actuelle.The default is the current date. NonNo
endDateendDate Datedate Date de fin dans la plage de dates des données d’installation à récupérer.The end date in the date range of install 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 les lignes de la réponse.One or more statements that filter the rows in the response. Chaque instruction contient un nom de champ du corps de la réponse et une valeur qui sont associés aux opérateurs EQ ou ne, et les instructions peuvent être combinées à l’aide de and ou de ou de.Each statement contains a field name from the response body and value that are associated with the eq or ne operators, and statements can be combined using and or or. Les valeurs de chaîne doivent être entourées par des guillemets dans le paramètre filter.String values must be surrounded by single quotes in the filter parameter. Vous pouvez spécifier les champs suivants dans le corps de la réponse :You can specify the following fields from the response body:

  • négocimarket
  • osVersionosVersion
  • deviceTypedeviceType
  • packageVersionpackageVersion
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 des données de résultat pour chaque installation.A statement that orders the result data values for each install. La syntaxe est orderby = Field [Order], champ [Order],.... Le paramètre Field peut être l’un des champs suivants du corps de la réponse :The syntax is orderby=field [order],field [order],.... The field parameter can be one of the following fields from the response body:

  • applicationNameapplicationName
  • datedate
  • deviceTypedeviceType
  • négocimarket
  • osVersionosVersion
  • packageVersionpackageVersion
  • successfulInstallCountsuccessfulInstallCount

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 dans le corps de la réponse :You can specify the following fields from the response body:

  • applicationNameapplicationName
  • datedate
  • deviceTypedeviceType
  • négocimarket
  • osVersionosVersion
  • packageVersionpackageVersion

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
  • successfulInstallCountsuccessfulInstallCount

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 des données d’installation de l’application.The following example demonstrates several requests for getting app install 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/installs?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/installs?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and deviceType eq 'PC' HTTP/1.1
Authorization: Bearer <your access token>

responseResponse

Response bodyResponse body

ValeurValue TypeType DescriptionDescription
ValeurValue tableauarray Tableau d’objets qui contiennent des données d’installation de regroupement.An array of objects that contain aggregate install data. Pour plus d’informations sur les données de chaque objet, consultez le tableau suivant.For more information about the data in each object, see the following table.
@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 demande est défini sur 10000, mais qu’il y a plus de 10000 lignes de données d’installation pour la requête.For example, this value is returned if the top parameter of the request is set to 10000 but there are more than 10000 rows of install 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.

Les éléments du tableau Value comportent les valeurs suivantes :Elements in the Value array contain the following values.

ValeurValue TypeType DescriptionDescription
Datedate stringstring Première date de la plage de dates pour les données d’installation.The first date in the date range for the install 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 d’installation.The Store ID of the app for which you are retrieving install data.
applicationNameapplicationName stringstring Nom d’affichage de l’application.The display name of the app.
deviceTypedeviceType stringstring L’une des chaînes suivantes qui spécifie le type d’appareil qui a effectué l’installation :One of the following strings that specifies the type of device that completed the install:

  • ORDINATEURSPC
  • NumérosPhone
  • Console-Xbox OneConsole-Xbox One
  • Console-série Xbox XConsole-Xbox Series X
  • IoTIoT
  • HologrammesHolographic
  • UnknownUnknown
packageVersionpackageVersion stringstring Version du package qui a été installé.The version of the package that was installed.
osVersionosVersion stringstring L’une des chaînes suivantes qui spécifie la version du système d’exploitation sur laquelle l’installation s’est produite :One of the following strings that specifies the OS version on which the install occurred:

  • Windows Phone 7.5Windows Phone 7.5
  • Windows Phone 8Windows Phone 8
  • Windows Phone 8.1Windows Phone 8.1
  • Windows Phone 10Windows Phone 10
  • Windows 8Windows 8
  • Windows 8.1Windows 8.1
  • Windows 10Windows 10
  • UnknownUnknown
marketmarket stringstring Code du pays ISO 3166 du marché sur lequel l’installation s’est produite.The ISO 3166 country code of the market where the install occurred.
successfulInstallCountsuccessfulInstallCount nombrenumber Nombre d’installations réussies qui se sont produites au niveau de l’agrégation spécifiée.The number of successful installs that occurred during the specified aggregation level.

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-02-01",
      "applicationId": "9NBLGGGZ5QDR",
      "applicationName": "Contoso Demo",
      "packageVersion": "1.0.0.0",
      "deviceType": "Phone",
      "market": "IT",
      "osVersion": "Windows Phone 8.1",
      "successfulInstallCount": 1
    }
  ],
  "@nextLink": "installs?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=2015/01/01&endDate=2016/02/01&top=1&skip=1&orderby=date desc",
  "TotalCount":23012
}