Obtener instalaciones de aplicaciones de escritorio

Use este URI de REST para obtener datos de instalación agregados en formato JSON para una aplicación de escritorio que haya agregado al programa de aplicación de escritorio de Windows. Este URI permite obtener datos de instalación durante un intervalo de fechas determinado y otros filtros opcionales. Esta información también está disponible en el informe de instalaciones de aplicaciones de escritorio del Centro de partners.

Requisitos previos

Para usar este método, primero debes hacer lo siguiente:

  • Si aún no lo has hecho, completa todos los requisitos previos de la API de análisis de Microsoft Store.
  • Consigue un token de acceso a Azure AD para utilizarlo en el encabezado de solicitud de este método. Una vez que haya obtenido un token de acceso, tiene 60 minutos para usarlo antes de que expire. Una vez que expire el token, puede obtener uno nuevo.

Solicitar

Sintaxis de la solicitud

Método URI de solicitud
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/installbasedaily

Encabezado de solicitud

Encabezado Tipo Descripción
Autorización string Necesario. Token de acceso de Azure AD con el formato Token<de portador>.

Parámetros de solicitud

Parámetro Tipo Descripción Obligatorio
applicationId string El identificador de producto de la aplicación de escritorio para la que desea recuperar los datos de instalación. Para obtener el identificador de producto de una aplicación de escritorio, abra cualquier informe de análisis de la aplicación de escritorio en el Centro de partners (como el informe de instalaciones) y recupere el identificador de producto de la dirección URL manteniendo el mouse sobre el vínculo para mostrar los detalles.
startDate date Fecha de inicio del intervalo de fechas de los datos de instalación que se van a recuperar. El valor predeterminado es 90 días antes de la fecha actual. No
endDate date Fecha de finalización del intervalo de fechas de los datos de instalación que se van a recuperar. La fecha actual es el valor predeterminado. No
top int Número de filas de datos que se van a devolver en la solicitud. Si no se especifica, el valor predeterminado y el valor máximo es 10000. Si hay más filas en la consulta, el cuerpo de la respuesta incluye un vínculo “Siguiente” que puedes usar para solicitar la siguiente página de datos. No
skip int Número de filas que se omiten en la consulta. Usa este parámetro para pasar de página en conjuntos de datos grandes. Por ejemplo, top=10000 y skip=0 recupera las primeras 10000 filas de datos, top=10000 y skip=10000 recupera las siguientes 10000 filas de datos, etc. No
filter string Una o varias instrucciones que filtran las filas de la respuesta. 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 mediante y u o. Los valores de cadena deben estar entre comillas simples en el parámetro de filtro. Puedes especificar los campos siguientes desde el cuerpo de la respuesta:

  • applicationVersion
  • deviceType
  • market
  • osVersion
  • osRelease
No
orderby string Instrucción que ordena los valores de los datos en los resultados para cada instalación. La sintaxis es orderby=field [order],field [order],.... El parámetro field puede ser uno de los campos siguientes del cuerpo de la respuesta:

  • productName
  • date
  • applicationVersion
  • deviceType
  • market
  • osVersion
  • osRelease
  • installBase

El parámetro order es opcional y puede ser asc o desc para especificar el orden ascendente o descendente de cada campo. El valor predeterminado es asc.

Este es un ejemplo de cadena orderby: orderby=date,market

No
groupby string Instrucción que aplica la agregación de datos solo a los campos especificados. Puedes especificar los campos siguientes desde el cuerpo de la respuesta:

  • applicationVersion
  • deviceType
  • market
  • osVersion
  • osRelease

Las filas de datos devueltas contendrán los campos especificados en el parámetro groupby, además de los siguientes:

  • applicationId
  • date
  • productName
  • installBase

No

Ejemplo de solicitud

En el ejemplo siguiente se muestran varias solicitudes para obtener datos de instalación de aplicaciones de escritorio. Reemplace el valor applicationId por el identificador del producto de su aplicación de escritorio.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/installbasedaily?applicationId=1234567890&startDate=2018-01-01&endDate=2018-02-01&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/installbasedaily?applicationId=1234567890&startDate=2018-01-01&endDate=2018-02-01&filter=market eq 'US' and deviceType eq 'PC' HTTP/1.1
Authorization: Bearer <your access token>

Respuesta

Response body

Valor Tipo Descripción
Valor array Matriz de objetos que contienen datos de instalación agregados. Para obtener más información sobre los datos de cada objeto, consulta la siguiente tabla.
@nextLink string Si hay páginas adicionales de datos, esta cadena contiene un URI que se puede usar para solicitar la siguiente página de datos. 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.
TotalCount int Número total de filas que figura en el resultado de datos de la consulta.

Los elementos de la matriz Value contienen los valores siguientes.

Valor Tipo Descripción
date string La fecha asociada al valor base de instalación.
applicationId string El identificador de producto de la aplicación de escritorio para la que recuperó los datos de instalación.
productName string Nombre para mostrar de la aplicación de escritorio como se deriva de los metadatos de los ejecutables asociados.
applicationVersion string Versión del ejecutable de la aplicación que se instaló.
deviceType string Una de las siguientes cadenas que especifica el tipo de dispositivo en el que está instalada la aplicación de escritorio:

  • PC
  • Server
  • Tablet
  • Unknown
market string El código de país ISO 3166 del mercado en el que está instalada la aplicación de escritorio.
osVersion string Una de las siguientes cadenas que especifica la versión del sistema operativo en la que está instalada la aplicación de escritorio:

  • Windows 7
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Windows Server 2016
  • Windows Server 1709
  • Unknown
osRelease string Una de las siguientes cadenas que especifica la versión del sistema operativo o el anillo piloto (como una subpoblación dentro de la versión del sistema operativo) en la que está instalada la aplicación de escritorio.

Para Windows 11: versión 2110

Para Windows 10:

  • Versión 1507
  • Versión 1511
  • Versión 1607
  • Versión 1703
  • Versión 1709
  • Versión preliminar
  • Modo anticipado del Insider
  • Modo aplazado del Insider

Para Windows Server 1709:

  • RTM

Para Windows Server 2016:

  • Versión 1607

Para Windows 8.1:

  • Actualización 1

Para Windows 7:

  • Service Pack 1

Si se desconoce la versión del sistema operativo o el anillo de distribución de paquestes piloto, este campo tiene el valor Desconocido.

installBase number Número de dispositivos distintos que tenían instalado el producto en el nivel de agregación especificado.

Ejemplo de respuesta

En el ejemplo siguiente se muestra un ejemplo de cuerpo de respuesta en formato JSON para esta solicitud.

{
  "Value": [
    {
      "date": "2018-01-24",
      "applicationId": "123456789",
      "productName": "Contoso Demo",
      "applicationVersion": "1.0.0.0",
      "deviceType": "PC",
      "market": "All",
      "osVersion": "Windows 10",
      "osRelease": "Version 1709",
      "installBase": 348218.0
    }
  ],
  "@nextLink": "desktop/installbasedaily?applicationId=123456789&startDate=2018-01-01&endDate=2018-02-01&top=10000&skip=10000&groupby=applicationVersion,deviceType,osVersion,osRelease",
  "TotalCount": 23012
}