Получение сведений о блоках обновлений для классического приложения
Используйте этот URI REST для получения сведений о устройствах с Windows 10 и Windows 11, на которых конкретный исполняемый файл в классическом приложении блокирует обновление Windows 10 или Windows 11. Этот универсальный код ресурса (URI) можно использовать только для классических приложений, добавленных в программу классического приложения Windows. Эти сведения также доступны в отчете "Блоки приложений" для классических приложений в Центре партнеров.
Этот универсальный код ресурса (URI) аналогичен блоку обновления для классического приложения, но возвращает сведения о блоке устройства для определенного исполняемого файла в классическом приложении.
Необходимые компоненты
Чтобы использовать этот метод, сначала необходимо выполнить следующие действия:
- Если это еще не сделано, выполните все предварительные требования для API аналитики Microsoft Store.
- Получите маркер доступа Azure AD для использования в заголовке запроса для этого метода. После получения маркера доступа у вас будет 60 минут, чтобы использовать его до истечения срока действия. После истечения срока действия маркера можно получить новый.
Запросить
Синтаксис запроса
Способ | URI запроса |
---|---|
GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockdetails |
Заголовок запроса
Верхний колонтитул | Тип | Описание |
---|---|---|
Авторизация | строка | Обязательный. Маркер доступа Azure AD в маркере> носителя<формы. |
Параметры запроса
Параметр | Тип | Описание | Обязательное поле |
---|---|---|---|
applicationId | строка | Идентификатор продукта классического приложения, для которого требуется получить блочные данные. Чтобы получить идентификатор продукта классического приложения, откройте любой отчет аналитики для классического приложения в Центре партнеров (например , отчет "Блоки") и получите идентификатор продукта из URL-адреса. | Да |
fileName | строка | Имя заблокированного исполняемого файла | |
startDate | Дата | Дата начала в диапазоне дат для получения данных блока. Значение по умолчанию — 90 дней до текущей даты. | No |
endDate | Дата | Дата окончания в диапазоне дат для получения данных блока. Значение по умолчанию — текущая дата. | No |
популярное | INT | Количество строк данных, возвращаемых в запросе. Максимальное значение и значение по умолчанию, если не указано значение 10000. Если в запросе есть больше строк, текст ответа содержит следующую ссылку, которую можно использовать для запроса следующей страницы данных. | No |
skip | INT | Количество строк, пропускаемых в запросе. Используйте этот параметр для страницы с помощью больших наборов данных. Например, top=10000 и skip=0 извлекает первые 10000 строк данных, top=10000 и skip=10000 извлекает следующие 10000 строк данных и т. д. | No |
Фильтр | строка | Одна или несколько инструкций, которые фильтруют строки в ответе. Каждая инструкция содержит имя поля из текста ответа и значения, связанного с операторами eq или ne, и операторы могут быть объединены с помощью или или. Строковые значения должны быть окружены одними кавычками в параметре фильтра . В тексте ответа можно указать следующие поля:
|
No |
orderby | строка | Инструкция, которая упорядочивает значения результирующих данных для каждого блока. Синтаксис — orderby=field [order], field [order],.... Параметр поля может быть одним из следующих полей из текста ответа:
Параметр order является необязательным и может быть asc или desc , чтобы указать возрастание или убывание для каждого поля. Значение по умолчанию — asc. Ниже приведен пример строки заказа : orderby=date,market |
No |
groupby | строка | Инструкция, которая применяет агрегирование данных только к указанным полям. В тексте ответа можно указать следующие поля:
Возвращаемые строки данных будут содержать поля, указанные в параметре groupby , а также следующие:
|
No |
Пример запроса
В следующем примере показано несколько запросов на получение данных блока классических приложений. Замените значение applicationId идентификатором продукта для классического приложения.
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
Текст ответа
Значение | Тип | Описание |
---|---|---|
Значение | array | Массив объектов, содержащих статистические данные блока. Дополнительные сведения о данных в каждом объекте см. в следующей таблице. |
@nextLink | строка | Если есть дополнительные страницы данных, эта строка содержит универсальный код ресурса (URI), который можно использовать для запроса следующей страницы данных. Например, это значение возвращается, если верхний параметр запроса имеет значение 10000, но для запроса имеется более 10000 строк блочных данных. |
TotalCount | INT | Общее количество строк в результатах данных для запроса. |
Элементы в массиве значений содержат следующие значения.
Значение | Тип | Описание |
---|---|---|
applicationId | строка | Идентификатор продукта классического приложения, для которого вы получили данные блока. |
Дата | строка | Дата, связанная со значением блока, попадает. |
productName | строка | Отображаемое имя классического приложения, полученное из метаданных связанных исполняемых файлов. |
fileName | строка | Исполняемый файл, который был заблокирован. |
applicationVersion | строка | Версия исполняемого файла приложения, заблокированного. |
osVersion | строка | Одна из следующих строк, указывающая версию ОС, в которой в настоящее время работает классическое приложение:
|
osRelease | строка | Одна из следующих строк, указывающая выпуск ОПЕРАЦИОННОй системы или кольцо переключения (как подпопление в версии ОС), на котором в настоящее время работает классическое приложение. Для Windows 11: версия 2110 Для Windows 10:
Для Windows Server 1709:
Для Windows Server 2016
Для Windows 8.1:
Для Windows 7:
Если выпуск ОС или кольцо полетов неизвестно, это поле имеет значение Unknown. |
на рынок | строка | Код страны ISO 3166 рынка, в котором заблокировано классическое приложение. |
deviceType | строка | Одна из следующих строк, указывающая тип устройства, на котором заблокировано классическое приложение:
|
blockType | строка | Одна из следующих строк, указывающая тип блока, найденного на устройстве:
|
архитектура | строка | Архитектура устройства, на котором существует блок:
|
целевые объекты | строка | Одна из следующих строк, указывающая выпуск ОС Windows 10 или Windows 11, на котором классическое приложение заблокировано:
|
deviceCount | number | Количество отдельных устройств с блоками на указанном уровне агрегирования. |
Пример ответа
В следующем примере показан пример текста ответа JSON для этого запроса.
{
"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
}