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

Используйте этот URI REST, чтобы получить статистические данные установки в формате JSON для настольного приложения, добавленного в программу Windows Desktop Application. Этот URI позволяет получать данные установки за заданный диапазон дат и с другими дополнительными фильтрами. Эти сведения также доступны в отчете об установках для настольных приложений в Центре партнеров.

Предпосылки

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

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

Просьба

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

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

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

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

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

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

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

Параметр 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/installbasedaily?applicationId=1234567890&startDate=2018-01-01&endDate=2018-02-01&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>

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

Ответ

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

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

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

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

  • ПК
  • Сервер
  • Планшет
  • Неизвестный
рынок струна Код страны ISO 3166 для рынка, на котором установлено настольное приложение.
Версия ОС струна Одна из следующих строк, указывающая версию ОС, на которую установлено классическое приложение:

  • 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.
installBase число/номер Количество уникальных устройств, на которых был установлен продукт на указанном уровне агрегирования.

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

В следующем примере показан пример текста ответа JSON для этого запроса.

{
  "Value": [
    {
      "date": "2018-01-24",
      "applicationId": "123456789",
      "productName": "Contoso Demo",
      "applicationVersion": "1.0.0.0",
      "deviceType": "PC",
      "market": "All",
      "osVersion": "Windows 10",
      "osRelease": "Version 1709",
      "installBase": 348218.0
    }
  ],
  "@nextLink": "desktop/installbasedaily?applicationId=123456789&startDate=2018-01-01&endDate=2018-02-01&top=10000&skip=10000&groupby=applicationVersion,deviceType,osVersion,osRelease",
  "TotalCount": 23012
}
  • Last updated on