Получение сведений о блоках обновлений для классического приложенияGet upgrade block details for your desktop application

Используйте этот универсальный код ресурса (URI) для получения сведений о устройствах Windows 10, на которых конкретный исполняемый файл в настольном приложении блокирует выполнение обновления 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. Этот URI можно использовать только для настольных приложений, добавленных в классическую программу Windows.You can use this URI only for desktop applications that you have added to the Windows Desktop Application program. Эти сведения также доступны в отчете Application Blocks для классических приложений в центре партнеров.This information is also available in the Application blocks report for desktop applications in Partner Center.

Этот URI похож на получение блоков обновления для настольного приложения, но возвращает сведения о блоке устройства для определенного исполняемого файла в классическом приложении.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.

Предварительные требованияPrerequisites

Для использования этого метода сначала необходимо сделать следующее:To use this method, you need to first do the following:

  • Если вы еще не сделали этого, выполните все необходимые условия для API аналитики для Microsoft Store.If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
  • Получите маркер доступа Azure AD, который будет использоваться в заголовке запроса этого метода.Obtain an Azure AD access token to use in the request header for this method. После получения маркера доступа у вас будет 60 минут, чтобы использовать его до истечения срока действия.After you obtain an access token, you have 60 minutes to use it before it expires. После истечения срока действия маркера можно получить новый маркер.After the token expires, you can obtain a new one.

ЗапросRequest

Синтаксис запросаRequest syntax

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockdetails

Заголовок запросаRequest header

ЗаголовокHeader ТипType ОписаниеDescription
АвторизацияAuthorization строкаstring Обязательный.Required. Маркер доступа Azure AD в формате Bearer <token>.The Azure AD access token in the form Bearer <token>.

Параметры запросаRequest parameters

ПараметрParameter ТипType ОписаниеDescription ОбязательноRequired
applicationIdapplicationId строкаstring Идентификатор продукта для классического приложения, для которого требуется получить данные блока.The product ID of the desktop application for which you want to retrieve block data. Чтобы получить идентификатор продукта для классического приложения, откройте любой аналитический отчет для настольного приложения в центре партнеров (например, отчет о блоках) и получите идентификатор продукта из 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 строкаstring Имя заблокированного исполняемого файлаThe name of the blocked executable
startDatestartDate Датаdate Начальная дата в диапазоне данных блока, который необходимо получить.The start date in the date range of block data to retrieve. Значение по умолчанию — 90 дней до текущей даты.The default is 90 days prior to the current date. НетNo
endDateendDate Датаdate Конечная дата в диапазоне данных блока, которые необходимо получить.The end date in the date range of block data to retrieve. По умолчанию используется текущая дата.The default is the current date. нетNo
toptop INTint Количество строк данных, возвращаемых в запросе.The number of rows of data to return in the request. Максимальное значение и значение по умолчанию (если параметр не указан) — 10 000.The maximum value and the default value if not specified is 10000. Если в запросе содержится больше строк, то тело ответа будет содержать ссылку «Далее», которую можно использовать для запроса следующей страницы данных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. НетNo
skipskip INTint Количество строк, пропускаемых в запросе.The number of rows to skip in the query. Используйте этот параметр для постраничного перемещения по большим наборам данных.Use this parameter to page through large data sets. Например, при top=10000 и skip=0 извлекаются первые 10 000 строк данных; при top=10000 и skip=10000 извлекаются следующие 10 000 строк данных и т. д.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. НетNo
фильтрfilter строкаstring Одно или несколько выражений для фильтрации строк в ответе.One or more statements that filter the rows in the response. Каждое выражение содержит имя поля из тела ответа и значение, которое связано с помощью операторов eq или ne; выражения можно комбинировать, используя операторы and или 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. В параметре filter строковые значения должны быть заключены в одиночные кавычки.String values must be surrounded by single quotes in the filter parameter. Вы можете указать следующие поля из тела ответа:You can specify the following fields from the response body:

  • аппликатионверсионapplicationVersion
  • architecturearchitecture
  • blockTypeblockType
  • deviceTypedeviceType
  • звонкmarket
  • osReleaseosRelease
  • osVersionosVersion
  • productNameproductName
  • таржетосtargetOs
НетNo
orderbyorderby строкаstring Инструкция, которая упорядочивает значения результирующих данных для каждого блока.A statement that orders the result data values for each block. Используется следующий синтаксис: orderby=field [order],field [order],..., где параметр field может принимать одно из следующих значений полей из тела ответа:The syntax is orderby=field [order],field [order],.... The field parameter can be one of the following fields from the response body:

  • аппликатионверсионapplicationVersion
  • architecturearchitecture
  • blockTypeblockType
  • datedate
  • deviceTypedeviceType
  • звонкmarket
  • osReleaseosRelease
  • osVersionosVersion
  • productNameproductName
  • таржетосtargetOs
  • девицекаунтdeviceCount

Параметр order является необязательным и может принимать значения asc или desc, которые указывают, соответственно, порядок сортировки по возрастанию или по убыванию для каждого поля.The order parameter is optional, and can be asc or desc to specify ascending or descending order for each field. Значение по умолчанию — ASC.The default is asc.

Ниже приведен пример строки OrderBy : OrderBy = Дата, рыночнаяHere is an example orderby string: orderby=date,market

НетNo
groupbygroupby строкаstring Выражение, которое применяет агрегирование данных только к указанным полям.A statement that applies data aggregation only to the specified fields. Вы можете указать следующие поля из тела ответа:You can specify the following fields from the response body:

  • аппликатионверсионapplicationVersion
  • architecturearchitecture
  • blockTypeblockType
  • deviceTypedeviceType
  • звонкmarket
  • osReleaseosRelease
  • osVersionosVersion
  • таржетосtargetOs

Возвращенные строки данных будут содержать поля, указанные в параметре groupby, а также:The returned data rows will contain the fields specified in the groupby parameter as well as the following:

  • applicationIdapplicationId
  • datedate
  • productNameproductName
  • девицекаунтdeviceCount

НетNo

Пример запросаRequest example

В следующем примере показано несколько запросов на получение данных о блоках приложений для настольных систем.The following example demonstrates several requests for getting desktop application block data. Замените значение APPLICATIONID идентификатором продукта для классического приложения.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>

ОтветResponse

Текст ответаResponse body

ЗначениеValue ТипType ОписаниеDescription
ЗначениеValue массивеarray Массив объектов, содержащих статистические данные блока.An array of objects that contain aggregate block data. Дополнительные сведения о данных в каждом объекте см. в следующей таблице.For more information about the data in each object, see the following table.
@nextLink строкаstring При наличии дополнительных страниц данных эта строка содержит универсальный код ресурса (URI), который можно использовать для запроса следующей страницы данных.If there are additional pages of data, this string contains a URI that you can use to request the next page of data. Например, это значение возвращается, если параметр Top запроса имеет значение 10000, но имеется более 10000 строк блочных данных для запроса.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 Общее количество строк в результирующих данных для запроса.The total number of rows in the data result for the query.

Элементы в массиве Value содержат следующие значения.Elements in the Value array contain the following values.

ЗначениеValue ТипType ОписаниеDescription
applicationIdapplicationId строкаstring Идентификатор продукта для классического приложения, для которого были получены данные блока.The product ID of the desktop application for which you retrieved block data.
Датаdate строкаstring Дата, связанная с числом попаданий в блок.The date associated with the block hits value.
productNameproductName строкаstring Отображаемое имя классического приложения, как оно получено из метаданных его связанных исполняемых файлов.The display name of the desktop application as derived from the metadata of its associated executable(s).
fileNamefileName строкаstring Заблокированный исполняемый файл.The executable that was blocked.
applicationVersionapplicationVersion строкаstring Версия заблокированного исполняемого файла приложения.The version of the application executable that was blocked.
osVersionosVersion строкаstring Одна из следующих строк, указывающая версию ОС, в которой в данный момент работает классическое приложение: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 строкаstring Одна из следующих строк, указывающая выпуск ОС или выходное кольцо (в виде подсистемы заполнения в версии ОС), в которой выполняется приложение для настольных компьютеров.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.

Для Windows 10.For Windows 10:

  • Версия 1507Version 1507
  • Версия 1511Version 1511
  • Версия 1607Version 1607
  • Версия 1703Version 1703
  • Версия 1709Version 1709
  • Release PreviewRelease Preview
  • Предварительная оценка — ранний доступInsider Fast
  • Предварительная оценка Windows — поздний доступInsider Slow

Для Windows Server 1709For Windows Server 1709:

  • RTMRTM

Для Windows Server 2016For Windows Server 2016:

  • Версия 1607Version 1607

Для Windows 8.1.For Windows 8.1:

  • Обновление 1Update 1

Для Windows 7.For Windows 7:

  • Пакет обновления 1 (SP1)Service Pack 1

Если выпуск операционной системы или цикл фокус-тестирования неизвестны, это поле имеет значение Unknown.If the OS release or flighting ring is unknown, this field has the value Unknown.

marketmarket строкаstring Код страны ISO 3166, на которой заблокировано настольное приложение.The ISO 3166 country code of the market in which the desktop application is blocked.
deviceTypedeviceType строкаstring Одна из следующих строк, указывающая тип устройства, на котором блокируется настольное приложение:One of the following strings that specifies the type of device on which the desktop application is blocked:

  • ACPIPC
  • ServerServer
  • ПланшетTablet
  • UnknownUnknown
blockTypeblockType строкаstring Одна из следующих строк, указывающая тип блока, найденного на устройстве:One of the following strings that specifies the type of block found on the device:

  • Потенциальные седиментPotential Sediment
  • Временный седиментTemporary Sediment
  • Уведомление среды выполненияRuntime Notification

Дополнительные сведения об этих типах блоков и о том, что они означают для разработчиков и пользователей, см. в описании отчета о блокировке приложения.For more information about these block types and what they mean to developers and users, see the description of the Application blocks report.

архитектураarchitecture строкаstring Архитектура устройства, на котором существует блок:The architecture of the device on which the block exists:

  • ARM64ARM64
  • СX86
таржетосtargetOs строкаstring Одна из следующих строк, указывающая выпуск ОС Windows 10, на котором блокируется запуск приложения для настольных систем:One of the following strings that specifies the Windows 10 OS release on which the desktop application is blocked from running:

  • Версия 1709Version 1709
  • Версия 1803Version 1803
deviceCountdeviceCount numbernumber Количество уникальных устройств с блоками на указанном уровне агрегирования.The number of distinct devices that have blocks at the specified aggregation level.

Пример ответаResponse example

В следующем примере демонстрируется пример тела ответа JSON на данный запрос.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
}