Obtener detalles de bloque de actualización de la aplicación de escritorioGet upgrade block details for your desktop application

Use este URI de REST para obtener los detalles de los dispositivos de Windows 10 en los que un archivo ejecutable específico de la aplicación de escritorio está bloqueando la ejecución de una actualización de Windows 10.Use this REST URI to get details for Windows 10 devices on which a specific executable in your desktop application is blocking a Windows 10 upgrade from running. Puede usar este URI solo para las aplicaciones de escritorio que ha agregado al programa de aplicación de escritorio de Windows.You can use this URI only for desktop applications that you have added to the Windows Desktop Application program. Esta información también está disponible en el Informe de bloques de aplicación para aplicaciones de escritorio en el centro de Partners.This information is also available in the Application blocks report for desktop applications in Partner Center.

Este URI es similar a obtener bloques de actualización para la aplicación de escritorio, pero devuelve información de bloque de dispositivo para un archivo ejecutable específico en la aplicación de escritorio.This URI is similar to Get upgrade blocks for your desktop application, but it returns device block info for a specific executable in your desktop application.

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/desktop/blockdetails

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 ID. del producto de la aplicación de escritorio para la que desea recuperar los datos de bloque.The product ID of the desktop application for which you want to retrieve block data. Para obtener el identificador de producto de una aplicación de escritorio, abra el Informe de análisis de la aplicación de escritorio en el centro de Partners (como el Informe de bloques) y recupere el identificador de producto de la dirección URL.To get the product ID of a desktop application, open any analytics report for your desktop application in Partner Center (such as the Blocks report) and retrieve the product ID from the URL. Yes
fileNamefileName stringstring Nombre del ejecutable bloqueadoThe name of the blocked executable
startDatestartDate datedate Fecha de inicio del intervalo de fechas de datos de bloque que se va a recuperar.The start date in the date range of block data to retrieve. El valor predeterminado es 90 días antes de la fecha actual.The default is 90 days prior to the current date. NoNo
endDateendDate datedate Fecha de finalización del intervalo de fechas de los datos de bloque que se van a recuperar.The end date in the date range of block 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:

  • applicationVersionapplicationVersion
  • architecturearchitecture
  • blockTypeblockType
  • deviceTypedeviceType
  • datamarketmarket
  • osReleaseosRelease
  • osVersionosVersion
  • NombreDeProductoproductName
  • destinostargetOs
NoNo
orderbyorderby stringstring Instrucción que ordena los valores de los datos de resultado de cada bloque.A statement that orders the result data values for each block. 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:

  • applicationVersionapplicationVersion
  • architecturearchitecture
  • blockTypeblockType
  • datedate
  • deviceTypedeviceType
  • datamarketmarket
  • osReleaseosRelease
  • osVersionosVersion
  • NombreDeProductoproductName
  • destinostargetOs
  • deviceCountdeviceCount

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:

  • applicationVersionapplicationVersion
  • architecturearchitecture
  • blockTypeblockType
  • deviceTypedeviceType
  • datamarketmarket
  • osReleaseosRelease
  • osVersionosVersion
  • destinostargetOs

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:

  • applicationIdapplicationId
  • datedate
  • NombreDeProductoproductName
  • deviceCountdeviceCount

NoNo

Ejemplo de solicitudRequest example

En el ejemplo siguiente se muestran varias solicitudes para obtener datos de bloque de aplicaciones de escritorio.The following example demonstrates several requests for getting desktop application block data. Reemplace el valor de ApplicationID por el ID. de producto de la aplicación de escritorio.Replace the applicationId value with the Product ID for your desktop application.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockdetails?applicationId=10238467886765136388&fileName=contoso.exe&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/blockdetails?applicationId=10238467886765136388&fileName=contoso.exe&startDate=2018-05-01&endDate=2018-06-07&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 bloque agregado.An array of objects that contain aggregate block 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 bloque 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 block 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
applicationIdapplicationId stringstring El ID. del producto de la aplicación de escritorio para la que recuperó los datos de bloque.The product ID of the desktop application for which you retrieved block data.
datedate stringstring Fecha asociada al valor de aciertos de bloque.The date associated with the block hits value.
ProductNameproductName stringstring Nombre para mostrar de la aplicación de escritorio que se deriva de los metadatos de los archivos ejecutables asociados.The display name of the desktop application as derived from the metadata of its associated executable(s).
fileNamefileName stringstring Ejecutable que se ha bloqueado.The executable that was blocked.
applicationVersionapplicationVersion stringstring Versión del ejecutable de la aplicación que se ha bloqueado.The version of the application executable that was blocked.
osVersionosVersion stringstring Una de las siguientes cadenas que especifica la versión del sistema operativo en la que se está ejecutando actualmente la aplicación de escritorio:One of the following strings that specifies the OS version on which the desktop application is currently running:

  • Windows 7Windows 7
  • Windows 8.1Windows 8.1
  • Windows 10Windows 10
  • Windows Server 2016Windows Server 2016
  • Windows Server 1709Windows Server 1709
  • UnknownUnknown
osReleaseosRelease stringstring Una de las siguientes cadenas que especifica la versión del sistema operativo o el anillo de vuelo (como un rellenado de la versión del sistema operativo) en el que se está ejecutando actualmente la aplicación de escritorio.One of the following strings that specifies the OS release or flighting ring (as a subpopulation within OS version) on which the desktop application is currently running.

Para Windows 10:For Windows 10:

  • Versión 1507Version 1507
  • Versión 1511Version 1511
  • Versión 1607Version 1607
  • Versión 1703Version 1703
  • Versión 1709Version 1709
  • Versión preliminarRelease Preview
  • Insider rápidoInsider Fast
  • Insider lentoInsider Slow

Para Windows Server 1709:For Windows Server 1709:

  • VERSIÓNRTM

Para Windows Server 2016:For Windows Server 2016:

  • Versión 1607Version 1607

Para Windows 8.1:For Windows 8.1:

  • Actualización 1Update 1

Para Windows 7:For Windows 7:

  • Service Pack 1Service Pack 1

Si se desconoce la versión del sistema operativo o el anillo de vuelo, este campo tiene el valor desconocido.If the OS release or flighting ring is unknown, this field has the value Unknown.

marketmarket stringstring El código de país ISO 3166 del mercado en el que se bloquea la aplicación de escritorio.The ISO 3166 country code of the market in which the desktop application is blocked.
deviceTypedeviceType stringstring Una de las siguientes cadenas que especifica el tipo de dispositivo en el que se bloquea la aplicación de escritorio:One of the following strings that specifies the type of device on which the desktop application is blocked:

  • PCPC
  • ServerServer
  • TabletaTablet
  • UnknownUnknown
blockTypeblockType stringstring Una de las siguientes cadenas que especifica el tipo de bloque que se encuentra en el dispositivo:One of the following strings that specifies the type of block found on the device:

  • Sedimentos potencialesPotential Sediment
  • Sedimentos temporalesTemporary Sediment
  • Notificación en tiempo de ejecuciónRuntime Notification

Para obtener más información sobre estos tipos de bloques y su significado para los desarrolladores y usuarios, consulte la descripción del Informe de bloques de aplicación.For more information about these block types and what they mean to developers and users, see the description of the Application blocks report.

arquitecturaarchitecture stringstring La arquitectura del dispositivo en el que existe el bloque:The architecture of the device on which the block exists:

  • ARM64ARM64
  • MicroprocesadorX86
destinostargetOs stringstring Una de las siguientes cadenas que especifica la versión del sistema operativo Windows 10 en la que se bloquea la ejecución de la aplicación de escritorio:One of the following strings that specifies the Windows 10 OS release on which the desktop application is blocked from running:

  • Versión 1709Version 1709
  • Versión 1803Version 1803
deviceCountdeviceCount numbernumber El número de dispositivos distintos que tienen bloques en el nivel de agregación especificado.The number of distinct devices that have blocks at 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": [
    {
     "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/blockdetails?applicationId=123456789&startDate=2018-01-01&endDate=2018-02-01&top=10000&skip=10000&groupby=applicationVersion,deviceType,osVersion,osRelease",
  "TotalCount": 23012
}