Получение сведений о приобретениях приложения

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

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

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

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

Запросить

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

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

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

Верхний колонтитул Тип Описание
Авторизация строка Обязательно. Маркер доступа 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, и операторы могут быть объединены с помощью или или. Строковые значения должны быть окружены одними кавычками в параметре фильтра . Например, filter=market eq 'US' и gender eq 'm'.

В тексте ответа можно указать следующие поля:

  • acquisitionType
  • ageGroup
  • storeClient
  • пол
  • Рынке
  • osVersion
  • deviceType
  • orderName
No
aggregationLevel строка Указывает диапазон времени, для которого требуется получить статистические данные. Может быть одной из следующих строк: день, неделя или месяц. Если не указано, значение по умолчанию равно дню. No
orderby строка Инструкция, которая упорядочивает значения результирующих данных для каждого приобретения. Синтаксис — orderby=field [order], field [order],.... Параметр поля может быть одной из следующих строк:
  • date
  • acquisitionType
  • ageGroup
  • storeClient
  • пол
  • Рынке
  • osVersion
  • deviceType
  • orderName

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

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

No
Groupby строка Инструкция, которая применяет агрегирование данных только к указанным полям. Можно указать следующие поля:
  • date
  • applicationName
  • acquisitionType
  • ageGroup
  • storeClient
  • пол
  • Рынке
  • osVersion
  • deviceType
  • orderName

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

  • date
  • applicationId
  • acquisitionQuantity

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

No

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0  HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and gender eq 'm'  HTTP/1.1
Authorization: Bearer <your access token>

Response

Текст ответа

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

Значения приобретения

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

Значение Тип Описание
Дата строка Первая дата в диапазоне дат для данных приобретения. Если запрос указал один день, это значение равно дате. Если запрос указал неделю, месяц или другой диапазон дат, это значение является первой датой в этом диапазоне дат.
applicationId строка Идентификатор магазина приложения, для которого извлекаются данные о приобретении.
applicationName строка Отображаемое имя приложения.
deviceType строка Одна из следующих строк, указывающая тип устройства, на котором произошло приобретение:
  • ПК
  • Для телефонов
  • Console-Xbox One
  • Серия Xbox X консоли
  • Интернет вещей
  • Голографической
  • Unknown
orderName строка Имя заказа.
storeClient строка Одна из следующих строк, указывающая версию Магазина, в которой произошло приобретение:
  • Магазин Windows Телефон (клиент)
  • Microsoft Store (клиент) (или Магазин Windows (клиент) при запросе данных до 23 марта 2018 г.
  • Microsoft Store (веб-сайт) (или Магазин Windows (веб-сайт) при запросе данных до 23 марта 2018 г.
  • Приобретение томов организациями
  • Другое
osVersion строка Одна из следующих строк, указывающая версию ОС, в которой произошло приобретение:
  • Windows Телефон 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Windows Телефон 10
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Unknown
на рынок строка Код страны ISO 3166 рынка, на котором произошло приобретение.
пол строка Одна из следующих строк, указывающая пол пользователя, который сделал приобретение:
  • m
  • f
  • Unknown
ageGroup строка Одна из следующих строк, указывающая возрастную группу пользователя, который сделал приобретение:
  • менее 13
  • 13-17
  • 18-24
  • 25-34
  • 35-44
  • 44-55
  • больше 55
  • Unknown
acquisitionType строка Одна из следующих строк, указывающих тип приобретения:
  • Бесплатно
  • Пробная версия
  • Платный
  • Рекламный код
  • Iap
  • Iap подписки
  • Частная аудитория
  • Предварительный заказ
  • Xbox Game Pass (или Game Pass, если запрашивать данные до 23 марта 2018 г.)
  • Диск
  • Предоплаченный код
acquisitionQuantity number Количество приобретений, произошедших во время указанного уровня агрегирования.

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

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

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

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

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

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "date": "2022-07-29",
            "acquisitionQuantity": 7,
            "purchasePriceUSDAmount": 0.0,
            "purchasePriceLocalAmount": 0.0,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
  ],
  "TotalCount": 1,
  "DataFreshnessTimestamp": "2022-07-29T08:42:00"
}

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=8/1/2021&endDate=12/21/2021&skip=0&filter=market&groupby=date,applicationName,acquisitionType,ageGroup,storeClient,gender,market,osVersion,deviceType  HTTP/1.1
Authorization: Bearer <your access token>

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

	{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "acquisitionType": "Free",
            "storeClient": "Microsoft Store (client)",
            "gender": "f",
            "market": "TW",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "date": "2021-08-01",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 0.0,
            "purchasePriceLocalAmount": 0.0,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "acquisitionType": "Free",
            "storeClient": "Microsoft Store (client)",
            "gender": "Unknown",
            "market": "BR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "date": "2021-08-01",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 0.0,
            "purchasePriceLocalAmount": 0.0,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
      ],  
  "TotalCount": 2,
  "DataFreshnessTimestamp": "2022-07-29T08:42:00"
 }