Получение сведений о ежемесячном использовании приложения

Используйте этот метод в API аналитики Microsoft Store для получения статистических данных об использовании (не включая многопользовательскую игру Xbox) в формате JSON для приложения в течение заданного диапазона дат (только за последние 90 дней) и других необязательных фильтров. Эти сведения также доступны в отчете об использовании в Центре партнеров.

Данные телеметрии для приложений PWA на основе Anaheim собираются на уровне устройства. Таким образом, метрики, связанные с пользователями, не будут доступны для таких продуктов. Дополнительные сведения о допустимости полей см. в разделе "Значения использования" ниже.

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

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

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

Запросить

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

Способ URI запроса
ПОЛУЧАЙ https://manage.devcenter.microsoft.com/v1.0/my/analytics/usagemonthly

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

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

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

Параметр Тип Описание Обязательное поле
applicationId строка Идентификатор приложения, для которого требуется получить данные проверки. Да
Дата начала Дата Дата начала в диапазоне дат для получения данных проверки. Значение по умолчанию — текущая дата. нет
Дата окончания Дата Дата окончания в диапазоне дат для получения данных проверки. Значение по умолчанию — текущая дата. нет
популярное INT Количество строк данных, возвращаемых в запросе. Максимальное значение и значение по умолчанию, если не указано значение 10000. Если в запросе есть больше строк, текст ответа содержит следующую ссылку, которую можно использовать для запроса следующей страницы данных. нет
пропустить INT Количество строк, пропускаемых в запросе. Используйте этот параметр для страницы с помощью больших наборов данных. Например, top=10000 и skip=0 извлекает первые 10000 строк данных, top=10000 и skip=10000 извлекает следующие 10000 строк данных и т. д. нет
Фильтр строка Одна или несколько инструкций, которые фильтруют строки в ответе. Каждая инструкция содержит имя поля из текста ответа и значения, связанного с операторами eq или ne, и операторы могут быть объединены с помощью или или. Строковые значения должны быть окружены одними кавычками в параметре фильтра. В тексте ответа можно указать следующие поля:
  • рынок
  • тип устройства
  • packageVersion (версия пакета)
нет
сортировать по строка Инструкция, которая упорядочивает значения результирующих данных. Синтаксис — orderby=field [order], field [order],.... Параметр поля может быть одной из следующих строк:
  • date
  • applicationId
  • applicationName
  • рынок
  • packageVersion (версия пакета)
  • тип устройства
  • название подписки
  • ежемесячноеКоличествоСессий
  • длительностьВзаимодействияВМинуты
  • ежемесячно активные пользователи
  • ежемесячно активные устройства
  • ежемесячные новые пользователи
  • среднее количество активных пользователей в день
  • среднее количество активных устройств за день
  • ежемесячныеНовыеУстройства

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

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

нет
groupby строка Инструкция, которая применяет агрегирование данных только к указанным полям. В тексте ответа можно указать следующие поля:
  • applicationName
  • название подписки
  • тип устройства
  • packageVersion (версия пакета)
  • рынок
  • date

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

  • applicationId
  • название подписки
  • ежемесячноеКоличествоСессий
  • длительностьВзаимодействияВМинуты
  • ежемесячно активные пользователи
  • ежемесячно активные устройства
  • ежемесячные новые пользователи
  • среднее количество активных пользователей в день
  • среднее количество активных устройств за день
  • ежемесячныеНовыеУстройства

Параметр groupby можно использовать с параметром aggregationLevel . Например: &groupby=ageGroup,market&aggregationLevel=week

нет

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/usagemonthly?applicationId=XXXXXXXXXXXX&startDate=2018-06-01&endDate=2018-07-01 HTTP/1.1  
Authorization: Bearer <your access token>

Ответ

Текст ответа

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

 

Значения использования

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

Значение Тип Описание Доступность UWP Доступность PWA на основе Anaheim Доступность Xbox
Дата строка Первая дата в диапазоне дат для данных об использовании. Если запрос указал один день, это значение равно дате. Если запрос указал неделю, месяц или другой диапазон дат, это значение является первой датой в этом диапазоне дат. Да Да Да
applicationId строка Идентификатор магазина приложения, для которого извлекаются данные об использовании. Да Да Да
название приложения строка Отображаемое имя приложения. Да Да Да
на рынок строка Код страны ISO 3166 рынка, где клиент использовал свое приложение. Да Да Да
версия_пакета строка Версия пакета, в котором произошло использование. Да Да нет
тип устройства строка Одна из следующих строк, указывающая тип устройства, в котором произошло использование:
  • ПК
  • Для телефонов
  • Console-Xbox One
  • Серия Xbox X консоли
  • Таблетка
  • Интернет вещей
  • Сервер
  • Голографический
  • Неизвестный
Да Да Да
название подписки строка Указывает, было ли использование через Xbox Game Pass. Да нет нет
Количество сессий в месяц длинный Количество сеансов пользователей в течение этого месяца. Да Да Да
Длительность вовлечения (в минутах) двойной точности Минуты, в течение которых пользователи активно используют приложение, измеряемое определенным периодом времени, начиная с запуска приложения (запуска процесса) и заканчивающегося после завершения (завершения процесса) или после периода бездействия. Да Да Да
ежемесячно активные пользователи длинный Число клиентов, использующих приложение в этом месяце. Да нет Да
ежемесячно активные устройства длинный Количество устройств, работающих в приложении в течение определенного периода времени, начиная с запуска приложения (запуска процесса) и заканчивая при завершении (окончании процесса) или после периода бездействия. Да Да Да
ежемесячное количество новых пользователей длинный Число клиентов, которые использовали свое приложение в первый раз в этом месяце. Да нет Да
Среднее количество активных пользователей в день двойной точности Среднее число клиентов, использующих приложение ежедневно. Да нет Да
среднее количество активных устройств в день двойной точности Среднее количество устройств, используемых для взаимодействия с приложением всеми пользователями ежедневно. Да Да Да
ежемесячноНовыеУстройства длинный Количество устройств, которые использовали приложение в первый раз в этом месяце. нет Да нет

Примечание.

Если поле недопустимо для определенного продукта, значение для этих полей будет отправлено как 0 или NULL в ответе. Вычисление новых пользователей и новых устройств выполняется с скользящим окном 3 года, т. е. если пользователь или устройство не использует приложение в течение 3 лет и выше, они будут рассматриваться как новый пользователь или устройство через 3 года.

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

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/usagemonthly?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>

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

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "deviceType": "All",
            "packageVersion": "All",
            "market": "All",
            "engagementDurationMinutes": 2828568.3,
            "monthlyActiveUsers": 165249,
            "monthlyActiveDevices": 165753,
            "monthlyNewUsers": 95787,
            "monthlySessionCount": 314263,
            "averageDailyActiveUsers": 192.506111111111,
            "averageDailyActiveDevices": 191.199722222222,
            "monthlyNewDevices": 0
        }
    ],
    "TotalCount": 1
}

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/usagemonthly?applicationId=9NBLGGGZ5QDR&startDate=2022-06-01&endDate=2022-07-01&groupby=applicationName,subscriptionName,deviceType,packageVersion,market,date&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>

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

{
    "Value": [
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "1.0.0.4957",
            "market": "JP",
            "engagementDurationMinutes": 0.3,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "1.0.0.4957",
            "market": "MX",
            "engagementDurationMinutes": 2.7,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "1.0.0.4957",
            "market": "Unknown",
            "engagementDurationMinutes": 0.1,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "1.0.0.4957",
            "market": "US",
            "engagementDurationMinutes": 0.2,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AE",
            "engagementDurationMinutes": 3.2,
            "monthlyActiveUsers": 2,
            "monthlyActiveDevices": 2,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 3,
            "averageDailyActiveUsers": 0.07,
            "averageDailyActiveDevices": 0.07,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AO",
            "engagementDurationMinutes": 1.2,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AR",
            "engagementDurationMinutes": 574.7,
            "monthlyActiveUsers": 39,
            "monthlyActiveDevices": 39,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 53,
            "averageDailyActiveUsers": 1.43,
            "averageDailyActiveDevices": 1.43,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AT",
            "engagementDurationMinutes": 5.3,
            "monthlyActiveUsers": 4,
            "monthlyActiveDevices": 4,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 9,
            "averageDailyActiveUsers": 0.17,
            "averageDailyActiveDevices": 0.17,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AU",
            "engagementDurationMinutes": 434.7,
            "monthlyActiveUsers": 22,
            "monthlyActiveDevices": 22,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 36,
            "averageDailyActiveUsers": 0.9,
            "averageDailyActiveDevices": 0.9,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AZ",
            "engagementDurationMinutes": 13.5,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        }
    ],
    "TotalCount": 10
}