Obtener instalaciones de aplicacionesGet app installs

Use este método en la API de Microsoft Store Analytics para obtener datos de instalación agregados en formato JSON para una aplicación durante un intervalo de fechas determinado y otros filtros opcionales.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. Esta información también está disponible en el Informe de adquisiciones del centro de Partners.This information is also available in the Acquisitions report in Partner Center.

Requisitos previosPrerequisites

Para usar este método, primero debes hacer lo siguiente:To use this method, you need to first do the following:

  • Si aún no lo ha hecho, complete todos los requisitos previos de la API de Microsoft Store Analytics.If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
  • Obtén un token de acceso de Azure AD para usarlo en el encabezado de la solicitud de este método.Obtain an Azure AD access token to use in the request header for this method. Una vez que haya obtenido un token de acceso, tiene 60 minutos para usarlo antes de que expire.After you obtain an access token, you have 60 minutes to use it before it expires. Si el token expira, puedes obtener uno nuevo.After the token expires, you can obtain a new one.

SolicitudRequest

Sintaxis de la solicitudRequest syntax

MétodoMethod URI de solicitudRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs

Encabezado de solicitudRequest header

EncabezadoHeader TipoType DescripciónDescription
AuthorizationAuthorization stringstring Necesario.Required. El token de acceso de Azure AD del formulario Bearer <token>.The Azure AD access token in the form Bearer <token>.

Parámetros de solicitudRequest parameters

ParámetroParameter TipoType DescripciónDescription ObligatorioRequired
applicationIdapplicationId stringstring El identificador de la tienda de la aplicación para la que desea recuperar los datos de instalación.The Store ID of the app for which you want to retrieve install data. Yes
startDatestartDate datedate Fecha de inicio del intervalo de fechas de los datos de instalación que se van a recuperar.The start date in the date range of install data to retrieve. La fecha predeterminada es la actual.The default is the current date. NoNo
endDateendDate datedate Fecha de finalización del intervalo de fechas de los datos de instalación que se van a recuperar.The end date in the date range of install data to retrieve. La fecha predeterminada es la actual.The default is the current date. NoNo
toptop intint Número de filas de datos que se devuelven en la solicitud.The number of rows of data to return in the request. El valor máximo y el valor predeterminado, si no se especifican, es 10 000.The maximum value and the default value if not specified is 10000. Si hay más filas en la consulta, el cuerpo de la respuesta incluye un vínculo que puedes usar para solicitar la siguiente página de datos.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. NoNo
skipskip intint Número de filas que se omiten en la consulta.The number of rows to skip in the query. Usa este parámetro para consultar grandes conjuntos de datos.Use this parameter to page through large data sets. Por ejemplo, los valores top=10000 y skip=0 recuperan las primeras 10 000 filas de datos, los valores top=10000 y skip=10000 recuperan las siguientes 10 000 filas de datos, y así sucesivamente.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. NoNo
filterfilter stringstring Una o más instrucciones que filtran las filas de la respuesta.One or more statements that filter the rows in the response. Cada instrucción contiene un nombre de campo del cuerpo de la respuesta y el valor que están asociados a los operadores EQ o ne , y las instrucciones se pueden combinar con and u or.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. Ten en cuenta que en el parámetro filter los valores de la cadena deben estar entre comillas simples.String values must be surrounded by single quotes in the filter parameter. Puede especificar los siguientes campos del cuerpo de la respuesta:You can specify the following fields from the response body:

  • datamarketmarket
  • osVersionosVersion
  • deviceTypedeviceType
  • packageVersionpackageVersion
NoNo
aggregationLevelaggregationLevel stringstring Especifica el intervalo de tiempo necesario para el que quieres recuperar datos agregados.Specifies the time range for which to retrieve aggregate data. Puede ser una de las siguientes cadenas: día, semana o mes.Can be one of the following strings: day, week, or month. Si no se especifica, el valor predeterminado es día.If unspecified, the default is day. NoNo
orderbyorderby stringstring Instrucción que ordena los valores de los datos de resultado de cada instalación.A statement that orders the result data values for each install. La sintaxis es OrderBy = Field [order], Field [order],.... El parámetro de campo puede ser uno de los siguientes campos del cuerpo de respuesta: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
  • datamarketmarket
  • osVersionosVersion
  • packageVersionpackageVersion
  • successfulInstallCountsuccessfulInstallCount

El parámetro order, en cambio, es opcional y puede ser asc o desc para especificar el orden ascendente o descendente de cada campo.The order parameter is optional, and can be asc or desc to specify ascending or descending order for each field. El valor predeterminado es ASC.The default is asc.

Este es un ejemplo de cadena OrderBy : OrderBy = Date, MarketHere is an example orderby string: orderby=date,market

NoNo
groupbygroupby stringstring Una instrucción que aplica la agregación de datos únicamente a los campos especificados.A statement that applies data aggregation only to the specified fields. Puede especificar los siguientes campos del cuerpo de la respuesta:You can specify the following fields from the response body:

  • applicationNameapplicationName
  • datedate
  • deviceTypedeviceType
  • datamarketmarket
  • osVersionosVersion
  • packageVersionpackageVersion

Las filas de datos que se devuelvan contendrán los campos especificados en el parámetro groupby y en los siguientes:The returned data rows will contain the fields specified in the groupby parameter as well as the following:

  • datedate
  • applicationIdapplicationId
  • successfulInstallCountsuccessfulInstallCount

Puedes usar el parámetro groupby con aggregationLevel.The groupby parameter can be used with the aggregationLevel parameter. Por ejemplo: & GroupBy = edad, Market & aggregationLevel = WeekFor example: &groupby=ageGroup,market&aggregationLevel=week

NoNo

 

Ejemplo de solicitudRequest example

En el ejemplo siguiente se muestran varias solicitudes para obtener datos de instalación de la aplicación.The following example demonstrates several requests for getting app install data. Sustituye el valor applicationId por el id. de la Tienda de la aplicación.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

Cuerpo de la respuestaResponse body

ValueValue TipoType DescripciónDescription
ValueValue arrayarray Matriz de objetos que contienen datos de instalación agregados.An array of objects that contain aggregate install data. Para obtener más información acerca de los datos de cada objeto, vea la tabla siguiente.For more information about the data in each object, see the following table.
@nextLink stringstring Si hay páginas adicionales de datos, esta cadena contiene un URI que puedes usar para solicitar la siguiente página de datos.If there are additional pages of data, this string contains a URI that you can use to request the next page of data. Por ejemplo, este valor se devuelve si el parámetro Top de la solicitud se establece en 10000, pero hay más de 10000 filas de datos de instalación para la consulta.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 El número total de filas del resultado de datos de la consulta.The total number of rows in the data result for the query.

Los elementos de la matriz Value contienen los siguientes valores.Elements in the Value array contain the following values.

ValueValue TipoType DescripciónDescription
datedate stringstring Primera fecha del intervalo de fechas de los datos de instalación.The first date in the date range for the install data. Si la solicitud especifica un solo día, este valor será esa fecha.If the request specified a single day, this value is that date. Si, por el contrario, la solicitud especifica una semana, un mes u otro intervalo de fechas, este valor será la primera fecha de ese intervalo de fechas.If the request specified a week, month, or other date range, this value is the first date in that date range.
applicationIdapplicationId stringstring El identificador de la tienda de la aplicación para la que se recuperan los datos de instalación.The Store ID of the app for which you are retrieving install data.
applicationNameapplicationName stringstring El nombre para mostrar de la aplicación.The display name of the app.
deviceTypedeviceType stringstring Una de las siguientes cadenas que especifica el tipo de dispositivo que completó la instalación:One of the following strings that specifies the type of device that completed the install:

  • PCPC
  • NúmeroPhone
  • Consola: Xbox OneConsole-Xbox One
  • Consola: serie Xbox XConsole-Xbox Series X
  • IoTIoT
  • HolographicHolographic
  • UnknownUnknown
packageVersionpackageVersion stringstring Versión del paquete que se instaló.The version of the package that was installed.
osVersionosVersion stringstring Una de las siguientes cadenas que especifica la versión del sistema operativo en la que se ha producido la instalación: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 El código de país ISO 3166 del mercado en el que se realizó la instalación.The ISO 3166 country code of the market where the install occurred.
successfulInstallCountsuccessfulInstallCount numbernumber El número de instalaciones correctas que se produjeron durante el nivel de agregación especificado.The number of successful installs that occurred during the specified aggregation level.

Ejemplo de respuestaResponse example

En el ejemplo siguiente se muestra el cuerpo de una respuesta JSON de ejemplo realizada para esta solicitud.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
}