Получить приобретения приложений

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

Предпосылки

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

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

Просьба

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

Метод Запрос URI
ПОЛУЧАЙ https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions

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

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

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

Параметр Тип Описание Обязательно
applicationId струна Идентификатор магазина приложения, для которого нужно получить данные о покупках. Да
Дата начала дата Дата начала в диапазоне дат для извлечения данных о сборе. Значение по умолчанию — текущая дата. нет
Дата окончания дата Конечная дата в диапазоне дат для извлечения данных, связанных с приобретением. Значение по умолчанию — текущая дата. нет
Верх инт Количество строк данных, возвращаемых в запросе. Максимальное значение и значение по умолчанию, если не указано значение 10000. Если в запросе есть больше строк, текст ответа содержит следующую ссылку, которую можно использовать для запроса следующей страницы данных. нет
пропустить инт Количество строк, пропускаемых в запросе. Используйте этот параметр для навигации по большим наборам данных. Например, top=10000 и skip=0 извлекает первые 10000 строк данных, top=10000 и skip=10000 извлекает следующие 10000 строк данных и т. д. нет
фильтр струна Одна или несколько инструкций, которые фильтруют строки в ответе. Каждая инструкция содержит имя поля из тела ответа и значения, связанные с операторами eq или ne, и инструкции могут быть объединены с помощью и или или. Строковые значения должны быть окружены одними кавычками в параметре фильтра . Например, filter=market eq 'US' и gender eq 'm'.

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

  • тип приобретения
  • возрастнаяГруппа
  • storeClient
  • род
  • рынок
  • версия ОС
  • типУстройства
  • orderName
нет
уровень агрегации струна Указывает диапазон времени, для которого требуется получить статистические данные. Может быть одной из следующих строк: день, неделя или месяц. Если не указано, значение по умолчанию равно дню. нет
сортировать по струна Заявление, которое упорядочивает значения результирующих данных для каждой выборки. Синтаксис — orderby=field [order], field [order],.... Параметр поле может быть одной из следующих строк:
  • дата
  • тип приобретения
  • возрастнаяГруппа
  • storeClient
  • род
  • рынок
  • версия ОС
  • типУстройства
  • orderName

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

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

нет
ГруппаПо струна Инструкция, которая применяет агрегирование данных только к указанным полям. Можно указать следующие поля:
  • дата
  • applicationName
  • тип приобретения
  • возрастнаяГруппа
  • storeClient
  • род
  • рынок
  • версия ОС
  • типУстройства
  • orderName

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

  • дата
  • applicationId
  • количество приобретения

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

нет

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

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

Ответ

Основная часть ответа

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

Стоимость приобретений

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

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

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

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