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

  • Статья

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

Необходимые компоненты

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

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

Запросить

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

Способ URI запроса
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/installbasedaily

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

Верхний колонтитул Тип Описание
Авторизация строка Обязательный. Маркер доступа Azure AD в маркере> носителя<формы.

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

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

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

  • Productname
  • date
  • applicationVersion
  • deviceType
  • Рынке
  • osVersion
  • osRelease
  • installBase

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

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

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

  • applicationVersion
  • deviceType
  • Рынке
  • osVersion
  • osRelease

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

  • applicationId
  • date
  • Productname
  • installBase

 No

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

В следующем примере показано несколько запросов на получение данных установки классических приложений. Замените значение 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>

Response

Текст ответа

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

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

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

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

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

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

Для Windows 10:

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

Для Windows Server 1709:

  • RTM

Для Windows Server 2016

  • Версия 1607

Для Windows 8.1:

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

Для Windows 7:

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

Если выпуск ОС или кольцо полетов неизвестно, это поле имеет значение Unknown.
installBase number Количество отдельных устройств, установленных продуктом на указанном уровне агрегирования.

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

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