Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Используйте этот метод в API аналитики Microsoft Store, чтобы получить сводные данные о приобретении для подписок дополнений для вашего приложения в течение заданного диапазона дат и при использовании дополнительных фильтров.
Предпосылки
Чтобы использовать этот метод, сначала необходимо выполнить следующие действия:
- Если это еще не сделано, выполните все предварительные требования для API аналитики Microsoft Store.
- Получите маркер доступа Azure AD для использования в заголовке запроса для этого метода. После получения маркера доступа у вас есть 60 минут, чтобы использовать его до истечения срока действия. После истечения срока действия токена можно получить новый токен.
Просьба
Синтаксис запроса
| Метод | Запрос URI |
|---|---|
| ПОЛУЧАЙ | https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions |
Заголовок запроса
| Заголовок | Тип | Описание |
|---|---|---|
| Авторизация | струна | Обязательное. Токен доступа Azure AD в формате Bearer<token>. |
Параметры запроса
| Параметр | Тип | Описание | Обязательно |
|---|---|---|---|
| applicationId | струна | Идентификатор магазина приложения, для которого требуется получить данные о приобретении добавок для подписки. | Да |
| идентификаторПродуктаПодписки | струна | Идентификатор хранилища надстройки подписки, для которой требуется получить данные о приобретении. Если это значение не указано, этот метод возвращает данные о приобретении для всех дополнений подписок указанного приложения. | нет |
| Дата начала | дата | Дата начала в диапазоне дат, относящихся к извлекаемым данным о приобретении надстроек подписки. Значение по умолчанию — текущая дата. | нет |
| Дата окончания | дата | Дата окончания диапазона дат для получения данных о приобретении дополнений подписки. Значение по умолчанию — текущая дата. | нет |
| Верх | инт | Количество строк данных, возвращаемых в запросе. Максимальное значение и значение по умолчанию, если не указано значение 100. Если в запросе есть больше строк, текст ответа содержит следующую ссылку, которую можно использовать для запроса следующей страницы данных. | нет |
| пропустить | инт | Количество строк, пропускаемых в запросе. Используйте этот параметр для навигации по большим наборам данных. Например, top=100 и skip=0 извлекает первые 100 строк данных, top=100 и skip=100 извлекает следующие 100 строк данных и т. д. | нет |
| фильтр | струна | Одно или несколько выражений, которые фильтруют содержимое тела ответа. Каждая инструкция может использовать операторы eq или ne, а операторы можно объединить с помощью иили. В инструкциях фильтра можно указать следующие строки (они соответствуют значениям в тексте ответа):
Ниже приведен пример параметра фильтра : filter=date eq '2017-07-08'. |
нет |
| уровень агрегации | струна | Указывает диапазон времени, для которого требуется получить статистические данные. Может быть одной из следующих строк: день, неделя или месяц. Если не указано, значение по умолчанию равно дню. | нет |
| сортировать по | струна | Инструкция, которая упорядочивает значения данных результатов для каждой приобретаемой надстройки подписки. Синтаксис — orderby=field [order], field [order],.... Параметр field может быть одной из следующих строк:
Параметр order является необязательным и может быть asc или desc , чтобы указать возрастание или убывание для каждого поля. Значение по умолчанию — asc. Ниже приведён пример строки orderby: orderby=date,market |
нет |
| ГруппаПо | струна | Инструкция, которая применяет агрегирование данных только к указанным полям. Можно указать следующие поля:
Параметр groupby можно использовать с параметром aggregationLevel . Например: groupby=market&aggregationLevel=week |
нет |
Пример запроса
В следующем примере демонстрируется, как получить данные о приобретении дополнительных функций подписки. Замените значение applicationId соответствующим идентификатором Магазина для приложения.
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions?applicationId=9NBLGGGZ5QDR&startDate=2017-07-07&endDate=2017-07-08 HTTP/1.1
Authorization: Bearer <your access token>
Ответ
Основная часть ответа
| Ценность | Тип | Описание |
|---|---|---|
| Ценность | массив | Массив объектов, содержащих обобщенные данные о приобретении надстроек подписки. Дополнительные сведения о данных в каждом объекте см. в разделе "Значения приобретения подписки " ниже. |
| @nextLink | струна | Если есть дополнительные страницы данных, эта строка содержит универсальный код ресурса (URI), который можно использовать для запроса следующей страницы данных. Например, это значение возвращается, если параметр запроса top установлен на 100, но в запросе имеется более 100 строк данных о приобретении надстроек подписки. |
| Общее количество | инт | Общее количество строк в результатах данных для запроса. |
Значения приобретения подписки
Элементы в массиве значений содержат следующие значения.
| Ценность | Тип | Описание |
|---|---|---|
| дата | струна | Первая дата в диапазоне дат для данных сбора. Если запрос указал один день, это значение равно дате. Если запрос указал неделю, месяц или другой диапазон дат, это значение является первой датой в этом диапазоне дат. |
| идентификаторПродуктаПодписки | струна | Идентификатор магазина дополнения к подписке, для которого извлекаются данные о приобретении. |
| имя_подписного_продукта | струна | Отображаемое имя расширения подписки. |
| applicationId | струна | Идентификатор магазина приложения, для которого осуществляется получение данных о приобретении дополнений к подписке. |
| название приложения | струна | Отображаемое имя приложения. |
| skuId | струна | Идентификатор номера SKU надстройки подписки, для которой извлекаются данные о приобретении. |
| тип устройства | струна | Одна из следующих строк, указывающая тип устройства, завершившего сбор данных:
|
| рынок | струна | Код страны ISO 3166 рынка, на котором произошло приобретение. |
| Код валюты | струна | Код валюты в формате ISO 4217 для валовой продажи до налогов. |
| Валовая продажа до налога | целое число | Валовые продажи в локальной валюте, указанной значением currencyCode . |
| общееКоличествоАктивных | целое число | Количество общих активных подписок за указанный период времени. Это эквивалентно сумме значений goodStandingActiveCount, pendingGraceActiveCount, graceActiveCount и lockedActiveCount . |
| Общее количество оттока | целое число | Общее количество подписок, деактивированных в течение указанного периода времени. Это эквивалентно сумме выставления счетовChurnCount, nonRenewalChurnCount, возмещаемого счета, chargebackChurnCount, earlyChurnCount и других значенийChurnCount. |
| новыйСчетчик | целое число | Количество новых приобретений подписки за указанный период времени, включая пробные версии. |
| счётчик продлений | целое число | Количество продлений подписки в течение указанного периода времени, включая продление, инициированное пользователем, и автоматическое продление. |
| количествоАктивныхВХорошемСостоянии | целое число | Количество подписок, которые были активны в течение указанного периода времени и где дата >окончания срока действия = значение endDate для запроса. |
| СчетчикОжиданияАктивнойЛьготы | целое число | Количество подписок, которые были активными в течение указанного периода времени, но имели сбой выставления счетов и где дата окончания подписки |
| количествоАктивныхПериодовGrace | целое число | Количество подписок, которые были активны в течение указанного периода времени, но имели сбой выставления счетов и где:
|
| LockedActiveCount | целое число | Количество подписок, которые находились в процессе взыскания оплаты (то есть подписка приближается к истечению срока действия, и Microsoft пытается получить средства для автоматического продления подписки) в указанный период времени и где:
|
| billingChurnCount | целое число | Количество подписок, которые были деактивированы в течение указанного периода времени из-за невозможности обработать платеж и где подписки ранее находились в процессе взыскания. |
| Количество отказов от продления подписки | целое число | Количество подписок, которые были деактивированы в течение указанного периода времени, поскольку они не были продлены. |
| возмещатьChurnCount | целое число | Количество подписок, которые были деактивированы в течение указанного периода времени, поскольку они были возвращены. |
| chargebackChurnCount | целое число | Количество подписок, которые были деактивированы в течение указанного периода времени из-за обратной оплаты. |
| раннийChurnCount | целое число | Количество подписок, которые были отключены в течение указанного периода времени, когда они находились в хорошей репутации. |
| otherChurnCount | целое число | Количество подписок, деактивированных в течение указанного периода времени по другим причинам. |
Пример запроса и ответа
В следующих фрагментах кода показан пример текста запроса и текста ответа JSON для этого запроса.
Пример запроса
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>
Пример ответа
{
"Value": [
{
"date": "2022-04-18",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Windows and Doors",
"grossSalesBeforeTax": 3460656.260391250,
"totalActiveCount": 20211321,
"totalChurnCount": 5605,
"newCount": 3810366,
"renewCount": 12102044,
"goodStandingActiveCount": 17893664,
"pendingGraceActiveCount": 2255792,
"graceActiveCount": 61833,
"lockedActiveCount": 32,
"billingChurnCount": 4,
"nonRenewalChurnCount": 0,
"refundChurnCount": 0,
"chargebackChurnCount": 0,
"earlyChurnCount": 2717,
"otherChurnCount": 2884
},
{
"date": "2022-04-18",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Unknown",
"grossSalesBeforeTax": 2342.580615228,
"totalActiveCount": 50550,
"totalChurnCount": 7,
"newCount": 8312,
"renewCount": 31446,
"goodStandingActiveCount": 44047,
"pendingGraceActiveCount": 6503,
"graceActiveCount": 0,
"lockedActiveCount": 0,
"billingChurnCount": 0,
"nonRenewalChurnCount": 0,
"refundChurnCount": 0,
"chargebackChurnCount": 0,
"earlyChurnCount": 5,
"otherChurnCount": 2
}
],
"TotalCount": 2
}
Пример запроса
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2021&endDate=04/20/2022&top=10&skip=0&orderby=date&groupby=date,subscriptionProductName,applicationName,skuId,market,deviceType&aggregationLevel=week
HTTP/1.1
Authorization: Bearer <your access token>
Пример ответа
{
"Value": [
{
"date": "2022-04-18",
"subscriptionProductName": "realms.subscription.monthly.10player.01",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Windows and Doors",
"skuId": "0100",
"market": "IT",
"deviceType": "Console-Xbox One",
"grossSalesBeforeTax": 0.0,
"totalActiveCount": 0,
"totalChurnCount": 0,
"newCount": 2,
"renewCount": 0,
"goodStandingActiveCount": 0,
"pendingGraceActiveCount": 0,
"graceActiveCount": 0,
"lockedActiveCount": 0,
"billingChurnCount": 0,
"nonRenewalChurnCount": 0,
"refundChurnCount": 0,
"chargebackChurnCount": 0,
"earlyChurnCount": 0,
"otherChurnCount": 0
},
{
"date": "2022-04-18",
"subscriptionProductName": "realms.subscription.monthly.10player.01",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Windows and Doors",
"skuId": "0100",
"market": "NO",
"deviceType": "Unknown",
"grossSalesBeforeTax": 0.0,
"totalActiveCount": 0,
"totalChurnCount": 0,
"newCount": 0,
"renewCount": 13,
"goodStandingActiveCount": 0,
"pendingGraceActiveCount": 0,
"graceActiveCount": 0,
"lockedActiveCount": 0,
"billingChurnCount": 0,
"nonRenewalChurnCount": 0,
"refundChurnCount": 0,
"chargebackChurnCount": 0,
"earlyChurnCount": 0,
"otherChurnCount": 0
},
{
"date": "2022-04-18",
"subscriptionProductName": "realms.subscription.monthly.10player.02",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Windows and Doors",
"skuId": "0100",
"market": "CA",
"deviceType": "Unknown",
"grossSalesBeforeTax": 0.0,
"totalActiveCount": 152,
"totalChurnCount": 0,
"newCount": 0,
"renewCount": 270,
"goodStandingActiveCount": 133,
"pendingGraceActiveCount": 19,
"graceActiveCount": 0,
"lockedActiveCount": 0,
"billingChurnCount": 0,
"nonRenewalChurnCount": 0,
"refundChurnCount": 0,
"chargebackChurnCount": 0,
"earlyChurnCount": 0,
"otherChurnCount": 0
}
],
"TotalCount": 3
}
Связанные темы