Получите блоки обновлений для настольного приложения

Используйте этот URI REST для получения сведений о устройствах Windows 10 и Windows 11, на которых ваше настольное приложение блокирует запуск обновления Windows 10 или Windows 11. Этот универсальный код ресурса (URI) можно использовать только для настольных приложений, которые вы добавили в программу настольных приложений Windows. Эти сведения также доступны в блоки приложений для классических приложений в Центре партнеров.

Для получения сведений о блоках устройства для конкретного исполняемого файла в десктопном приложении см. Сведения о блоке обновления для десктопного приложения.

Предпосылки

Чтобы использовать этот метод, сначала необходимо выполнить следующие действия:

  • Если это еще не сделано, выполните все предварительные требования для API аналитики Microsoft Store.
  • Получите маркер доступа Azure AD для использования в заголовке запроса для этого метода. После получения маркера доступа у вас есть 60 минут, чтобы использовать его до истечения срока действия. После истечения срока действия токена можно получить новый токен.

Просьба

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

Метод Запрос URI
ПОЛУЧАЙ https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockhits

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

Заголовок Тип Описание
Авторизация струна Обязательное. Токен доступа Azure AD в формате Bearer<token>.

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

Параметр Тип Описание Обязательно
applicationId струна Идентификатор продукта настольного приложения, для которого вы хотите получить блочные данные. Чтобы получить идентификатор продукта настольного приложения, откройте любой отчет аналитики для настольного приложения в Центре партнеров (например, отчет Блоки) и получите идентификатор продукта из URL-адреса. Да
Дата начала дата Дата начала диапазона дат для получения данных блока. Значение по умолчанию — 90 дней до текущей даты. нет
Дата окончания дата Дата окончания диапазона дат для извлечения данных блока. Значение по умолчанию — текущая дата. нет
Верх инт Количество строк данных, возвращаемых в запросе. Максимальное значение и значение по умолчанию, если не указано значение 10000. Если в запросе есть больше строк, текст ответа содержит следующую ссылку, которую можно использовать для запроса следующей страницы данных. нет
пропустить инт Количество строк, пропускаемых в запросе. Используйте этот параметр для навигации по большим наборам данных. Например, top=10000 и skip=0 извлекает первые 10000 строк данных, top=10000 и skip=10000 извлекает следующие 10000 строк данных и т. д. нет
фильтр струна Одна или несколько инструкций, которые фильтруют строки в ответе. Каждое выражение содержит имя поля из текста ответа и значение, связанное с операторами eq или ne, и выражения могут быть объединены с помощью и или или. Строковые значения должны быть окружены одними кавычками в параметре фильтра . В тексте ответа можно указать следующие поля:

  • applicationVersion
  • архитектура
  • тип блока
  • тип устройства
  • имя файла
  • рынок
  • osRelease
  • версия ОС
  • productName
  • целевые операционные системы
нет
сортировать по струна Инструкция, которая упорядочивает значения результирующих данных для каждого блока. Синтаксис — orderby=field [order], field [order],.... Параметр поля может быть одним из следующих полей из текста ответа:

  • applicationVersion
  • архитектура
  • тип блока
  • дата
  • тип устройства
  • имя файла
  • рынок
  • osRelease
  • версия ОС
  • productName
  • целевые операционные системы
  • количество устройств

Параметр order является необязательным и может принимать значения asc или desc, чтобы указать порядок по возрастанию или по убыванию для каждого поля. Значение по умолчанию — asc.

Ниже приведен пример строки orderby: orderby=date,market

нет
ГруппаПо струна Инструкция, которая применяет агрегирование данных только к указанным полям. В тексте ответа можно указать следующие поля:

  • applicationVersion
  • архитектура
  • тип блока
  • тип устройства
  • имя файла
  • рынок
  • osRelease
  • версия ОС
  • целевые операционные системы

Возвращаемые строки данных будут содержать поля, указанные в параметре groupby , а также следующие:

  • applicationId
  • дата
  • productName
  • количество устройств

нет

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

В следующем примере показано несколько запросов на получение данных блокировки настольных приложений. Замените значение applicationId идентификатором продукта для настольного приложения.

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>

Ответ

Основная часть ответа

Ценность Тип Описание
Ценность массив Массив объектов, содержащих агрегированные данные блока. Дополнительные сведения о данных в каждом объекте см. в следующей таблице.
@nextLink струна Если есть дополнительные страницы данных, эта строка содержит универсальный код ресурса (URI), который можно использовать для запроса следующей страницы данных. Например, это значение возвращается, если параметру верхнего запроса задано значение 10000, но имеется более 10000 строк блочных данных для этого запроса.
Общее количество инт Общее количество строк в результатах данных для запроса.

Элементы в массиве значений содержат следующие значения.

Ценность Тип Описание
applicationId струна Идентификатор продукта настольного приложения, для которого вы получили данные блока.
дата струна Дата, связанная со значением попаданий блока.
названиеПродукта струна Отображаемое имя настольного приложения, полученное из метаданных его связанного исполняемого файла(ов).
имя файла струна Исполняемый файл, который был заблокирован.
версия приложения струна Версия исполняемого файла приложения, заблокированного.
Версия ОС струна Одна из следующих строк, указывающая версию ОС, в которой в настоящее время работает классическое приложение:

  • Windows 7
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Windows Server 2016
  • Windows Server 1709
  • Неизвестный
osRelease струна Одна из следующих строк, указывающая выпуск операционной системы или тестовое кольцо (как подпопуляция в версии ОС), на котором в настоящее время работает настольное приложение.

Для Windows 11 : версия 2110

Для Windows 10:

  • Версия 1507
  • Версия 1511
  • Версия 1607
  • Версия 1703
  • Версия 1709
  • Предварительная версия выпуска
  • Программа Insider Fast
  • Инсайдер Медленно

Для Windows Server 1709:

  • РТМ

Для Windows Server 2016:

  • Версия 1607

Для Windows 8.1:

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

Для Windows 7:

  • Пакет обновления 1

Если выпуск ОС или флайтинговое кольцо неизвестны, это поле имеет значение Unknown.

рынок струна Код страны ISO 3166 рынка, в котором заблокировано настольное приложение.
тип устройства струна Одна из следующих строк, указывающая тип устройства, на котором заблокировано десктопное приложение:

  • ПК
  • Сервер
  • Планшет
  • Неизвестный
тип блока струна Одна из следующих строк, указывающая тип блока, найденного на устройстве:

  • потенциальный осадок
  • Временный осадок
  • Уведомление среды выполнения

Дополнительные сведения об этих типах блоков и о том, что они означают для разработчиков и пользователей, см. в описании отчетаблоков приложений .
архитектура струна Архитектура устройства, на котором существует блок:

  • ARM64
  • X86
целевые операционные системы струна Одна из следующих строк, указывающая выпуск ОС Windows 10 или Windows 11, на котором настольное приложение заблокировано от выполнения:

  • Версия 1709
  • Версия 1803
Количество устройств число/номер Количество отдельных устройств с блоками на указанном уровне агрегирования.

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

В следующем примере показан пример текста ответа 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/blockhits?applicationId=123456789&startDate=2018-01-01&endDate=2018-02-01&top=10000&skip=10000&groupby=applicationVersion,deviceType,osVersion,osRelease",
  "TotalCount": 23012
}