Obtener bloques de actualización de la aplicación de escritorio

Usa este URI rest para obtener información sobre windows 10 y Windows 11 dispositivos en los que la aplicación de escritorio bloquea la ejecución de una actualización de Windows 10 o Windows 11. Puede usar este URI solo para aplicaciones de escritorio que haya agregado al programa Aplicación de escritorio de Windows. Esta información también está disponible en el informe Bloques de aplicaciones para aplicaciones de escritorio en el Centro de partners.

Para obtener detalles sobre los bloques de dispositivos para un archivo ejecutable específico en la aplicación de escritorio, consulte Obtención de los detalles del bloque de actualización de la aplicación de escritorio.

Requisitos previos

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

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

Solicitud

Sintaxis de la solicitud

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

Encabezado de solicitud

Encabezado Tipo Descripción
Authorization 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 Identificador de producto de la aplicación de escritorio para la que desea recuperar datos de bloque. 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 (por ejemplo, el informe Bloques) y recupere el identificador de producto de la dirección URL.
startDate date Fecha de inicio en el intervalo de fechas de los datos de bloque 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 bloque que se van a recuperar. La fecha predeterminada es la actual. No
top int Número de filas de datos que se devuelven en la solicitud. El valor máximo y el valor predeterminado, si no se especifican, es 10 000. 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. No
skip int Número de filas que se omiten en la consulta. Usa este parámetro para consultar grandes conjuntos de datos. 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. No
filter string Una o más instrucciones que filtran las filas de la respuesta. Cada instrucción contiene un nombre de campo del cuerpo de la respuesta y el valor asociados a los operadores eq o ne, y las instrucciones se pueden combinar mediante yo . Ten en cuenta que en el parámetro filter los valores de la cadena deben estar entre comillas simples. Puede especificar los siguientes campos desde el cuerpo de la respuesta:

  • applicationVersion
  • architecture
  • blockType
  • deviceType
  • fileName
  • Mercado
  • osRelease
  • osVersion
  • Productname
  • targetOs
No
orderby string Instrucción que ordena los valores de datos de resultado para cada bloque. La sintaxis es orderby=field [order],field [order],.... El parámetro field puede ser uno de los siguientes campos del cuerpo de la respuesta:

  • applicationVersion
  • architecture
  • blockType
  • date
  • deviceType
  • fileName
  • Mercado
  • osRelease
  • osVersion
  • Productname
  • targetOs
  • deviceCount

El parámetro order, en cambio, 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 Una instrucción que aplica la agregación de datos únicamente a los campos especificados. Puede especificar los siguientes campos desde el cuerpo de la respuesta:

  • applicationVersion
  • architecture
  • blockType
  • deviceType
  • fileName
  • Mercado
  • osRelease
  • osVersion
  • targetOs

Las filas de datos que se devuelvan contendrán los campos especificados en el parámetro groupby y en los siguientes:

  • applicationId
  • date
  • Productname
  • deviceCount

No

Ejemplo de solicitud

En el ejemplo siguiente se muestran varias solicitudes para obtener datos de bloqueo de aplicaciones de escritorio. Reemplace el valor applicationId por el id. de producto de la aplicación de escritorio.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockhits?applicationId=5126873772241846776&startDate=2018-05-01&endDate=2018-06-07&skip=0 HTTP/1.1
Authorization: Bearer <your access token>

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

Response

Response body

Valor Tipo Descripción
Valor array Matriz de objetos que contienen datos de bloque agregados. Para obtener más información sobre los datos de cada objeto, vea la tabla siguiente.
@nextLink cadena Si hay páginas adicionales de datos, esta cadena contiene un URI que puedes usar para solicitar la siguiente página de datos. Por ejemplo, este valor se devuelve si el parámetro superior de la solicitud se establece en 10000, pero hay más de 10000 filas de datos de bloque para la consulta.
TotalCount int El número total de filas del resultado de datos de la consulta.

Los elementos de la matriz Value contienen los siguientes valores.

Valor Tipo Descripción
applicationId cadena Identificador de producto de la aplicación de escritorio para la que recuperó datos de bloque.
date string Fecha asociada al valor de aciertos del bloque.
ProductName cadena El nombre para mostrar de la aplicación de escritorio como derivado de los metadatos de sus ejecutables asociados.
fileName cadena Ejecutable que se bloqueó.
applicationVersion cadena Versión del ejecutable de la aplicación que se bloqueó.
osVersion cadena Una de las siguientes cadenas que especifica la versión del sistema operativo en la que se ejecuta actualmente la aplicación de escritorio:

  • Windows 7
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Windows Server 2016
  • Windows Server 1709
  • Unknown
osRelease cadena Una de las siguientes cadenas que especifica el anillo de lanzamiento o de vuelo del sistema operativo (como subpoblación dentro de la versión del sistema operativo) en el que la aplicación de escritorio se está ejecutando actualmente.

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
  • Insider Fast
  • Insider Slow

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 liberación del sistema operativo o el anillo de vuelo, este campo tiene el valor Desconocido.

market string Código de país ISO 3166 del mercado en el que se bloquea la aplicación de escritorio.
deviceType cadena Una de las siguientes cadenas que especifica el tipo de dispositivo en el que se bloquea la aplicación de escritorio:

  • PC
  • Servidor
  • Tablet
  • Unknown
blockType cadena Una de las siguientes cadenas que especifica el tipo de bloque que se encuentra en el dispositivo:

  • Posible sedimento
  • Sedimento temporal
  • Notificación en tiempo de ejecución

Para obtener más información sobre estos tipos de bloques y lo que significan para desarrolladores y usuarios, consulte la descripción del informe Bloques de aplicaciones.
arquitectura cadena La arquitectura del dispositivo en el que existe el bloque:

  • ARM64
  • X86
targetOs cadena Una de las siguientes cadenas que especifica la versión del sistema operativo Windows 10 o Windows 11 en la que se bloquea la ejecución de la aplicación de escritorio:

  • Versión 1709
  • Versión 1803
deviceCount number Número de dispositivos distintos que tienen bloques en el nivel de agregación especificado.

Ejemplo de respuesta

En el ejemplo siguiente se muestra el cuerpo de una respuesta JSON de ejemplo realizada para esta solicitud.

{
  "Value": [
    {
     "applicationId": "10238467886765136388",
     "date": "2018-06-03",
     "productName": "Contoso Demo",
     "fileName": "contosodemo.exe",
     "applicationVersion": "2.2.2.0",
     "osVersion": "Windows 8.1",
     "osRelease": "Update 1",
     "market": "ZA",
     "deviceType": "All",
     "blockType": "Runtime Notification",
     "architecture": "X86",
     "targetOs": "RS4",
     "deviceCount": 120
    }
  ],
  "@nextLink": "desktop/blockhits?applicationId=123456789&startDate=2018-01-01&endDate=2018-02-01&top=10000&skip=10000&groupby=applicationVersion,deviceType,osVersion,osRelease",
  "TotalCount": 23012
}