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

Статья
01/10/2024

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

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

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

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

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

Запросить

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

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

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

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

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

Параметр	Тип	Описание	Обязательное поле
applicationId	строка	Идентификатор приложения, для которого требуется получить данные проверки.	Да
startDate	Дата	Дата начала в диапазоне дат для получения данных проверки. Значение по умолчанию — текущая дата.	No
endDate	Дата	Дата окончания в диапазоне дат для получения данных проверки. Значение по умолчанию — текущая дата.	No
популярное	INT	Количество строк данных, возвращаемых в запросе. Максимальное значение и значение по умолчанию, если не указано значение 10000. Если в запросе есть больше строк, текст ответа содержит следующую ссылку, которую можно использовать для запроса следующей страницы данных.	No
skip	INT	Количество строк, пропускаемых в запросе. Используйте этот параметр для страницы с помощью больших наборов данных. Например, top=10000 и skip=0 извлекает первые 10000 строк данных, top=10000 и skip=10000 извлекает следующие 10000 строк данных и т. д.	No
Фильтр	строка	Одна или несколько инструкций, которые фильтруют строки в ответе. Каждая инструкция содержит имя поля из текста ответа и значения, связанного с операторами eq или ne, и операторы могут быть объединены с помощью или или. Строковые значения должны быть окружены одними кавычками в параметре фильтра. В тексте ответа можно указать следующие поля: рынок deviceType packageVersion	No
orderby	строка	Инструкция, которая упорядочивает значения результирующих данных. Синтаксис — orderby=field [order], field [order],.... Параметр поля может быть одной из следующих строк: date applicationId applicationName рынок packageVersion deviceType subscriptionName dailySessionCount engagementDurationMinutes dailyActiveUsers dailyActiveDevices dailyNewUsers monthlyActiveUsers monthlyActiveDevices monthlyNewUsers dailyNewDevices monthlyNewDevices Параметр order является необязательным и может быть asc или desc , чтобы указать возрастание или убывание для каждого поля. Значение по умолчанию — asc. Ниже приведен пример строки заказа : orderby=date,market	No
groupby	строка	Инструкция, которая применяет агрегирование данных только к указанным полям. В тексте ответа можно указать следующие поля: applicationName subscriptionName deviceType packageVersion рынок date Возвращаемые строки данных будут содержать поля, указанные в параметре groupby , а также следующие: applicationId subscriptionName dailySessionCount engagementDurationMinutes dailyActiveUsers dailyActiveDevices dailyNewUsers monthlyActiveUsers monthlyActiveDevices monthlyNewUsers dailyNewDevices monthlyNewDevices Параметр groupby можно использовать с параметром aggregationLevel . Например: &groupby=ageGroup,market&aggregationLevel=week	No

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/usagedaily?applicationId=XXXXXXXXXXXX&startDate=2018-08-10&endDate=2018-08-14 HTTP/1.1
Authorization: Bearer <your access token>

Response

Текст ответа

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

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

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

Значение	Тип	Описание	Доступность UWP	Доступность PWA на основе Anaheim	Доступность Xbox
Дата	строка	Первая дата в диапазоне дат для данных об использовании. Если запрос указал один день, это значение равно дате. Если запрос указал неделю, месяц или другой диапазон дат, это значение является первой датой в этом диапазоне дат.	Да	Да	Да
applicationId	строка	Идентификатор магазина приложения, для которого извлекаются данные об использовании.	Да	Да	Да
applicationName	строка	Отображаемое имя приложения.	Да	Да	Да
deviceType	строка	Одна из следующих строк, указывающая тип устройства, в котором произошло использование: ПК Для телефонов Console-Xbox One Серия Xbox X консоли Таблетка Интернет вещей Сервер Голографический Unknown	Да	Да	Да
packageVersion	строка	Версия пакета, в котором произошло использование.	Да	Да	Нет
на рынок	строка	Код страны ISO 3166 рынка, где клиент использовал свое приложение.	Да	Да	Да
subscriptionName	строка	Указывает, было ли использование через Xbox Game Pass.	Да	No	No
dailySessionCount	длинный	Количество сеансов пользователей в этот день.	Да	Да	Да
engagementDurationMinutes	двойной точности	Минуты, в течение которых пользователи активно используют приложение, измеряемое определенным периодом времени, начиная с запуска приложения (запуска процесса) и заканчивающегося после завершения (завершения процесса) или после периода бездействия.	Да	Да	Да
dailyActiveUsers	длинный	Число клиентов, использующих приложение в тот день.	Да	No	Да
dailyActiveDevices	длинный	Количество ежедневных устройств, используемых для взаимодействия с приложением всеми пользователями.	Да	Да	Да
dailyNewUsers	длинный	Количество клиентов, которые использовали свое приложение в первый раз в тот день.	Да	No	Да
monthlyActiveUsers	длинный	Число клиентов, использующих приложение в этом месяце.	Да	No	Да
monthlyActiveDevices	длинный	Количество устройств, работающих в приложении в течение определенного периода времени, начиная с запуска приложения (запуска процесса) и заканчивая при завершении (окончании процесса) или после периода бездействия.	Да	Да	Да
monthlyNewUsers	длинный	Число клиентов, которые использовали свое приложение в первый раз в этом месяце.	Да	No	Да
dailyNewDevices	длинный	Количество устройств, которые использовали приложение в первый раз в тот день.	No	Да	Нет
monthlyNewDevices	длинный	Количество устройств, которые использовали приложение впервые за последние 30 дней.	No	Да	Нет

Примечание.

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

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

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

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

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

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

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "deviceType": "All",
            "packageVersion": "All",
            "market": "All",
            "dailySessionCount": 6102,
            "engagementDurationMinutes": 75801.0,
            "dailyActiveUsers": 3866,
            "dailyActiveDevices": 3855,
            "dailyNewUsers": 2041,
            "monthlyActiveUsers": 85206,
            "monthlyActiveDevices": 88995,
            "monthlyNewUsers": 63184,
            "dailyNewDevices": 0,
            "monthlyNewDevices": 0
        }
    ],
    "TotalCount": 1
}

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/usagedaily?applicationId=9NBLGGGZ5QDR&startDate=06/19/2022&endDate=07/20/2022&top=10&skip=0&groupby=applicationName,subscriptionName,deviceType,packageVersion,market,date

HTTP/1.1
Authorization: Bearer <your access token>

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

{
    "Value": [
        {
            "date": "2022-07-11",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "1.4.0.17837",
            "market": "BR",
            "dailySessionCount": 1,
            "engagementDurationMinutes": 35.2,
            "dailyActiveUsers": 1,
            "dailyActiveDevices": 1,
            "dailyNewUsers": 0,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "dailyNewDevices": 0,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-07-04",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AD",
            "dailySessionCount": 1,
            "engagementDurationMinutes": 2.7,
            "dailyActiveUsers": 1,
            "dailyActiveDevices": 1,
            "dailyNewUsers": 0,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "dailyNewDevices": 0,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-24",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AE",
            "dailySessionCount": 2,
            "engagementDurationMinutes": 2.9,
            "dailyActiveUsers": 1,
            "dailyActiveDevices": 1,
            "dailyNewUsers": 0,
            "monthlyActiveUsers": 2,
            "monthlyActiveDevices": 2,
            "monthlyNewUsers": 0,
            "dailyNewDevices": 0,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-07-08",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AE",
            "dailySessionCount": 1,
            "engagementDurationMinutes": 0.5,
            "dailyActiveUsers": 1,
            "dailyActiveDevices": 1,
            "dailyNewUsers": 0,
            "monthlyActiveUsers": 2,
            "monthlyActiveDevices": 2,
            "monthlyNewUsers": 0,
            "dailyNewDevices": 0,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-26",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AO",
            "dailySessionCount": 1,
            "engagementDurationMinutes": 1.2,
            "dailyActiveUsers": 1,
            "dailyActiveDevices": 1,
            "dailyNewUsers": 0,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "dailyNewDevices": 0,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-19",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AR",
            "dailySessionCount": 1,
            "engagementDurationMinutes": 1.0,
            "dailyActiveUsers": 1,
            "dailyActiveDevices": 1,
            "dailyNewUsers": 0,
            "monthlyActiveUsers": 40,
            "monthlyActiveDevices": 40,
            "monthlyNewUsers": 0,
            "dailyNewDevices": 0,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-20",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AR",
            "dailySessionCount": 2,
            "engagementDurationMinutes": 10.9,
            "dailyActiveUsers": 2,
            "dailyActiveDevices": 2,
            "dailyNewUsers": 0,
            "monthlyActiveUsers": 42,
            "monthlyActiveDevices": 42,
            "monthlyNewUsers": 0,
            "dailyNewDevices": 0,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-21",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AR",
            "dailySessionCount": 6,
            "engagementDurationMinutes": 32.8,
            "dailyActiveUsers": 3,
            "dailyActiveDevices": 3,
            "dailyNewUsers": 0,
            "monthlyActiveUsers": 44,
            "monthlyActiveDevices": 43,
            "monthlyNewUsers": 0,
            "dailyNewDevices": 0,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AR",
            "dailySessionCount": 1,
            "engagementDurationMinutes": 0.1,
            "dailyActiveUsers": 1,
            "dailyActiveDevices": 1,
            "dailyNewUsers": 0,
            "monthlyActiveUsers": 43,
            "monthlyActiveDevices": 42,
            "monthlyNewUsers": 0,
            "dailyNewDevices": 0,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-23",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AR",
            "dailySessionCount": 2,
            "engagementDurationMinutes": 0.3,
            "dailyActiveUsers": 2,
            "dailyActiveDevices": 2,
            "dailyNewUsers": 0,
            "monthlyActiveUsers": 42,
            "monthlyActiveDevices": 42,
            "monthlyNewUsers": 0,
            "dailyNewDevices": 0,
            "monthlyNewDevices": 0
        }
    ],
    "@nextLink": "usagedaily?applicationId=9NBLGGGZ5QDR&startDate=2022/06/19&endDate=2022/07/21&groupby=applicationName,subscriptionName,deviceType,packageVersion,market,date&top=10&skip=10",
    "TotalCount": 765
}

Поделиться через

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

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

Запросить

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

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

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

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

Response

Текст ответа

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

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

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

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

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

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

Обратная связь

Дополнительные ресурсы

Поделиться через

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

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

Запросить

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

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

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

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

Response

Текст ответа

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

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

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

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

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

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

См. также

Обратная связь

Дополнительные ресурсы