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


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

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

Предварительные условия

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

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

Примечание.

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

Запрос

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

Способ URI запроса
ПОЛУЧИТЬ https://manage.devcenter.microsoft.com/v1.0/my/analytics/addonacquisitions

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

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

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

Требуется параметр applicationId или addonProductId. Чтобы получить данные о приобретении для всех надстроек, зарегистрированных для этого приложения, укажите параметр applicationId. Чтобы получить данные о приобретении для конкретной надстройки, укажите параметр addonProductId. Если указать оба параметра, параметр applicationId игнорируется.

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

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/addonacquisitions?applicationId=9WZDNCRFJ314&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/addonacquisitions?applicationId=9WZDNCRFJ314&startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0&filter=market eq 'GB' and gender eq 'm' HTTP/1.1 

Authorization: Bearer <your access token>

Ответ

Текст ответа

Значение Тип Описание
Значение массив Массив объектов, содержащих сводные данные о приобретении дополнительных модулей. Дополнительные сведения о данных в каждом объекте см. в разделе ниже "Значения приобретения надстройки".
Общее количество INT Общее количество строк в результатах данных для запроса.

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

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

Значение Тип Описание
Дата строка Первая дата в диапазоне дат для данных сбора. Если запрос указал один день, это значение равно дате. Если запрос указал неделю, месяц или другой диапазон дат, это значение является первой датой в этом диапазоне дат.
addonProductId строка ProductId надстройки, для которой извлекаются данные о приобретении.
дополнительноеИмяПродукта строка Отображаемое имя надстройки. Это значение отображается только в данных ответа, если параметр aggregationLevel имеет значение day, если в параметре groupby не указано поле addonProductName.
applicationId строка ProductId приложения, для которого требуется получить данные о приобретении дополнительных компонентов.
Имя приложения строка Отображаемое имя игры.
тип устройства строка Одна из следующих строк, указывающая тип устройства, завершив приобретение:
  • "PC"
  • "Телефон"
  • Консоль Xbox One
  • "Консольная серия Xbox X"
  • "IoT"
  • "Сервер"
  • Планшет
  • голографический
  • "Неизвестно"
storeClient строка Одна из следующих строк, указывающая версию Магазина, в которой произошло приобретение:
  • Магазин Windows Phone (клиент)
  • "Microsoft Store (клиент)" (или "Магазин Windows (клиент)", если запрашивать данные до 23 марта 2018 г.)
  • Microsoft Store (web)" (или "Магазин Windows (web)", если запрашивать данные до 23 марта 2018 г.)
  • "Приобретение томов организациями"
  • "Другое"
osVersion строка Версия ОС, в которой произошло приобретение. Для этого метода значение всегда равно либо Windows 10, либо Windows 11.
рынок строка Код страны ISO 3166 рынка, на котором произошло приобретение.
пол строка Одна из следующих строк, указывающая пол пользователя, который сделал приобретение:
  • "m"
  • "f"
  • "Неизвестно"
возраст строка Одна из следующих строк, указывающая возрастную группу пользователя, который сделал приобретение:
  • "менее 13"
  • "13-17"
  • "18-24"
  • 25-34
  • "35-44"
  • 44-55
  • "больше 55"
  • "Неизвестно"
Тип приобретения строка Одна из следующих строк, указывающих тип приобретения:
  • "Бесплатный"
  • "Пробная версия"
  • "Платный"
  • "Рекламный код"
  • Iap
  • "Подписка Iap"
  • "Частная аудитория"
  • "Предварительный заказ"
  • "Xbox Game Pass" (или "Game Pass", если запрашивать данные до 23 марта 2018 г.)
  • Диск
  • "Предоплаченный код"
  • "Платный предварительный заказ"
  • "Отмененный предварительный заказ"
  • "Сбой предварительного заказа"
количество приобретения целое число Количество приобретений, которые произошли.
inAppProductId (Идентификатор продукта в приложении) строка Идентификатор продукта, в котором используется эта надстройка.
inAppProductName строка Имя продукта, в котором используется эта надстройка.
тип платежного инструмента строка Тип инструмента оплаты, используемый для приобретения.
sandboxId строка Идентификатор Sandbox, созданный для игры. Это может быть значение RETAIL или частный идентификатор песочницы.
xboxTitleId строка Идентификатор Xbox-игры из XDP, если это применимо.
код местной валюты строка Код локальной валюты на основе страны или региона учетной записи Центра партнеров.
Идентификатор продукта Xbox строка Идентификатор продукта Xbox из XDP, если это применимо.
идентификатор доступности строка Идентификатор доступности продукта из XDP, если применимо.
skuId строка Идентификатор SKU продукта из XDP, если это применимо.
skuDisplayName строка Отображаемое имя SKU продукта из XDP, если применимо.
xboxParentProductId строка Идентификатор родительского продукта Xbox из XDP, если это применимо.
названиеРодительскогоПродукта строка Имя родительского продукта из XDP, если применимо.
productTypeName строка Имя типа продукта из XDP, если применимо.
тип налога на покупку строка При необходимости приобрести налоговый тип продукта из XDP.
purchasePriceUSDAmount число Сумма, уплаченная клиентом за дополнение, преобразованная в USD.
Цена покупки в местной валюте число / номер Сумма, уплаченная клиентом за надстройку, в валюте региона.
сумма налога на покупку в долларах США число Сумма налога, примененная к дополнению, преобразована в USD.
сумма местного налога на покупку номер Если применимо, учтите местный налог на продукт от XDP.

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

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

{ 
  "Value": [ 
    { 
            "inAppProductId": "9NBLGGH1864K", 
            "inAppProductName": "866879", 
            "addonProductId": "9NBLGGH1864K", 
            "addonProductName": "866879", 
            "date": "2017-11-05", 
            "applicationId": "9WZDNCRFJ314", 
            "applicationName": "Tetris Blitz", 
            "acquisitionType": "Iap", 
            "age": "35-49", 
            "deviceType": "Phone", 
            "gender": "m", 
            "market": "US", 
            "osVersion": "Windows Phone 8.1", 
            "paymentInstrumentType": "Credit Card", 
            "sandboxId": "RETAIL", 
            "storeClient": "Windows Phone Store (client)", 
            "xboxTitleId": "", 
            "localCurrencyCode": "USD", 
            "xboxProductId": "00000000-0000-0000-0000-000000000000", 
            "availabilityId": "", 
            "skuId": "", 
            "skuDisplayName": "Full", 
            "xboxParentProductId": "", 
            "parentProductName": "Tetris Blitz", 
            "productTypeName": "Add-On", 
            "purchaseTaxType": "", 
            "acquisitionQuantity": 1, 
            "purchasePriceUSDAmount": 1.08, 
            "purchasePriceLocalAmount": 0.09, 
            "purchaseTaxUSDAmount": 1.08, 
            "purchaseTaxLocalAmount": 0.09 
        } 
    ], 

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