Получите данные о приобретениях для ваших игр и приложений

Используйте этот метод в API аналитики Microsoft Store, чтобы получить агрегированные данные о приобретении в формате JSON для приложений UWP и игр Xbox One, которые были загружены через портал разработчика Xbox (XDP) и доступны на панели мониторинга XDP Analytics.

Замечание

Этот API не предоставляет ежедневные статистические данные до 1 октября 2016 г.

Предпосылки

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

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

Просьба

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

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

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

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

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

Параметр Тип Описание Обязательно
applicationId струна Идентификатор продукта игры Xbox One, для которой вы извлекаете данные о приобретении. Чтобы получить идентификатор продукта игры, перейдите к игре в программе XDP Analytics и получите идентификатор продукта из URL-адреса. Кроме того, при скачивании данных о приобретениях из отчета аналитики Центра партнеров идентификатор продукта включается в TSV-файл. Да
Дата начала дата Дата начала в диапазоне дат для извлечения данных о сборе. Значение по умолчанию — текущая дата. нет
Дата окончания дата Конечная дата в диапазоне дат для извлечения данных, связанных с приобретением. Значение по умолчанию — текущая дата. нет
фильтр струна Одна или несколько инструкций, которые фильтруют строки в ответе. Каждое выражение содержит имя поля из текста ответа и значение, связанное с операторами eq или ne, и выражения могут быть объединены с помощью и или или. Строковые значения должны быть окружены одними кавычками в параметре фильтра. Например, filter=market eq 'US' и gender eq 'm'.
В тексте ответа можно указать следующие поля:
  • Тип приобретения
  • возраст
  • storeClient
  • пол
  • рынок
  • версия ОС
  • тип устройства
  • sandboxId
нет
уровень агрегации струна Указывает диапазон времени, для которого требуется получить статистические данные. Может быть одной из следующих строк: день, неделя или месяц. Если не указано, значение по умолчанию равно дню. нет
сортировать по струна Заявление, которое упорядочивает значения результирующих данных для каждой выборки. Синтаксис — orderby=field [order], field [order],... Параметр field может быть одной из следующих строк:
  • дата
  • Тип приобретения
  • возраст
  • storeClient
  • пол
  • рынок
  • версия ОС
  • тип устройства
  • Тип платёжного инструмента
  • sandboxId
  • xboxTitleId
Параметр order является необязательным и может принимать значения asc или desc, чтобы указать порядок по возрастанию или по убыванию для каждого поля. Значение по умолчанию — asc. Ниже приведен пример строки orderby: orderby=date,market
нет
ГруппаПо струна Инструкция, которая применяет агрегирование данных только к указанным полям. Можно указать следующие поля:
  • дата
  • applicationName
  • Тип приобретения
  • возраст
  • storeClient
  • пол
  • рынок
  • версия ОС
  • тип устройства
  • Тип платёжного инструмента
  • sandboxId
  • xboxTitleId
Возвращаемые строки данных будут содержать поля, указанные в параметре groupby , а также следующие:
  • дата
  • applicationId
  • количество приобретения
Параметр groupby можно использовать с параметром aggregationLevel. Например: &groupby=age,market&aggregationLevel=week
нет

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

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/acquisitions?applicationId=9WZDNCRFHXHT&startDate=1/1/2017&endDate=2/1/2019&skip=0&filter=market eq 'US' and gender eq 'm' HTTP/1.1 
Authorization: Bearer <your access token> 

Ответ

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

Ценность Тип Описание
Ценность массив Массив объектов, содержащий агрегированные данные о приобретении для игры. Дополнительные сведения о данных в каждом объекте см. в разделе «Параметры получения данных» ниже.
Общее количество целое число Общее количество строк в результатах данных для запроса.

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

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

Ценность Тип Описание
дата струна Первая дата в диапазоне дат для данных сбора. Если запрос указал один день, это значение равно дате. Если запрос указал неделю, месяц или другой диапазон дат, это значение является первой датой в этом диапазоне дат.
applicationId струна Идентификатор продукта игры Xbox One, для которой вы извлекаете данные о приобретении.
название приложения струна Отображаемое имя игры.
Тип приобретения струна Одна из следующих строк, указывающих тип приобретения:
  • Бесплатно
  • Пробная версия
  • Оплачено
  • Рекламный код
  • ИАП
  • Подписка Iap
  • Частная аудитория
  • Предварительный заказ
  • Xbox Game Pass (или Game Pass , если запрашивать данные до 23 марта 2018 г.)
  • Диск
  • Предоплаченный код
  • плата за предварительный заказ
  • отмененный предварительный заказ
  • Неудавшийся предварительный заказ
возраст струна Одна из следующих строк, указывающая возрастную группу пользователя, который сделал приобретение:
  • менее 13
  • 13-17
  • 18-24
  • 25-34
  • 35-44
  • 44-55
  • больше 55
  • Неизвестный
тип устройства струна Одна из следующих строк, указывающая тип устройства, завершившего процесс приобретения:
  • ПК
  • Телефон
  • Console-Xbox One
  • Консоль Xbox Series X
  • Интернет вещей
  • Сервер
  • Планшет
  • Голографический
  • Неизвестный
гендер струна Одна из следующих строк, указывающая пол пользователя, который сделал приобретение:
  • m
  • f
  • Неизвестный
рынок струна Код страны ISO 3166 рынка, на котором произошло приобретение.
Версия ОС струна Версия ОС, в которой произошло приобретение. Для этого метода это значение всегда Windows 10 или Windows 11.
тип платежного инструмента струна Одна из следующих строк, указывающих инструкцию по оплате, используемую для приобретения:
  • Кредитная карта
  • Карта для прямого дебетования
  • предполагаемая покупка
  • БАЛАНС MS Balance
  • Мобильный оператор
  • онлайн-банковский перевод
  • PayPal
  • разделение транзакций
  • Обмен маркеров
  • Нулевая сумма оплачена
  • электронный кошелек
  • Неизвестный
sandboxId струна Идентификатор песочницы, созданный для игры. Это может быть значение RETAIL или частный идентификатор песочницы.
storeClient струна Одна из следующих строк, указывающая версию Магазина, в которой произошло приобретение:
  • Магазин Windows Phone (клиент)
  • Microsoft Store (клиент) (или Windows Store (клиент) при запросе данных до 23 марта 2018 г.)
  • Microsoft Store (web) (или Windows Store (web), если запрашивать данные до 23 марта 2018 г.)
  • Оптовая закупка организациями
  • Другое
xboxTitleId струна Идентификатор заголовка Xbox Live (представлен в шестнадцатеричном значении), назначенный порталом разработчика Xbox (XDP) для игр с поддержкой Xbox Live.
количество приобретения число/номер Количество приобретений, произошедших во время указанного уровня агрегирования.
сумма покупки в долларах США число/номер Сумма, выплачиваемая клиентом за приобретение, преобразованная в доллары США, с использованием ежемесячного курса обмена.
СуммаНалогаНаПокупкуВДолларахСША число/номер Сумма налога, примененная к приобретению, преобразованная в USD.
код местной валюты струна Код локальной валюты на основе страны или региона учетной записи Центра партнеров.
Идентификатор продукта Xbox струна Идентификатор продукта Xbox из XDP, если это применимо.
идентификатор доступности струна Идентификатор доступности продукта из XDP, если применимо.
skuId струна Идентификатор SKU продукта из XDP, если это применимо.
skuDisplayName струна Отображаемое имя SKU продукта из XDP, если применимо.
xboxParentProductId (идентификатор родительского продукта Xbox) струна Идентификатор основного продукта Xbox из XDP, если это применимо.
Название родительского продукта струна Имя родительского продукта из XDP, если применимо.
названиеТипаПродукта струна Имя типа продукта из XDP, если применимо.
тип налога на покупку струна Указать налоговый тип на покупку продукта из XDP, при необходимости.
Цена покупки в местной валюте число/номер Цена покупки в местной валюте продукта от XDP, если применимо.
сумма_местного_налога_на_покупку число/номер Местная сумма налога на продукт от XDP, если применимо.

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

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

{ 
    "Value": [ 
        { 
            "date": "2019-01-15T01:00:00.0000000Z", 
            "applicationId": "9WZDNCRFHXHT", 
            "applicationName": null, 
            "acquisitionType": "Paid", 
            "age": null, 
            "deviceType": "Phone", 
            "gender": null, 
            "market": "US", 
            "osVersion": "Windows 11", 
            "paymentInstrumentType": null, 
            "sandboxId": "RETAIL", 
            "storeClient": "Microsoft Store (client)", 
            "xboxTitleId": null, 
            "localCurrencyCode": "USD", 
            "xboxProductId": null, 
            "availabilityId": "B42LRTSZ2MCJ", 
            "skuId": "0010", 
            "skuDisplayName": null, 
            "xboxParentProductId": null, 
            "parentProductName": null, 
            "productTypeName": "Game", 
            "purchaseTaxType": "TaxesNotIncluded", 
            "acquisitionQuantity": 1, 
            "purchasePriceUSDAmount": 3.08, 
            "purchasePriceLocalAmount": 3.08, 
            "purchaseTaxUSDAmount": 0.09, 
            "purchaseTaxLocalAmount": 0.09 
        } 
    ], 

    "@nextLink": null,
    
    "TotalCount": 12221 
}