Получение данных о приобретении игр и приложений
Используйте этот метод в API аналитики Microsoft Store, чтобы получить статистические данные о приобретении в формате JSON для приложений UWP и игр Xbox One, которые были приема через портал разработчика Xbox (XDP) и доступны на панели мониторинга XDP Analytics.
Примечание.
Этот API не предоставляет ежедневные статистические данные до 1 октября 2016 г.
Необходимые компоненты
Чтобы использовать этот метод, сначала необходимо выполнить следующие действия:
- Если это еще не сделано, выполните все предварительные требования для API аналитики Microsoft Store.
- Получите маркер доступа Azure AD для использования в заголовке запроса для этого метода. После получения маркера доступа у вас будет 60 минут, чтобы использовать его до истечения срока действия. После истечения срока действия маркера можно получить новый.
Запросить
Синтаксис запроса
| Способ | URI запроса |
|---|---|
| GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/acquisitions |
Заголовок запроса
| Верхний колонтитул | Тип | Описание |
|---|---|---|
| Авторизация | строка | Обязательно. Маркер доступа Azure AD в форме носителя<token>. |
Параметры запроса
| Параметр | Тип | Описание | Обязательное поле |
|---|---|---|---|
| applicationId | строка | Идентификатор продукта игры Xbox One, для которой вы извлеките данные о приобретении. Чтобы получить идентификатор продукта игры, перейдите к игре в программе XDP Analytics и получите идентификатор продукта из URL-адреса. Кроме того, при скачивании данных о приобретениях из отчета аналитики Центра партнеров идентификатор продукта включается в TSV-файл. | Да |
| startDate | Дата | Дата начала в диапазоне дат получения данных о приобретении. Значение по умолчанию — текущая дата. | No |
| endDate | Дата | Дата окончания в диапазоне дат получения данных о приобретении. Значение по умолчанию — текущая дата. | No |
| Фильтр | строка | Одна или несколько инструкций, которые фильтруют строки в ответе. Каждая инструкция содержит имя поля из текста ответа и значения, связанного с операторами eq или ne, и операторы могут быть объединены с помощью или или. Строковые значения должны быть окружены одними кавычками в параметре фильтра. Например, filter=market eq 'US' и gender eq 'm'. В тексте ответа можно указать следующие поля:
|
No |
| aggregationLevel | строка | Указывает диапазон времени, для которого требуется получить статистические данные. Может быть одной из следующих строк: день, неделя или месяц. Если не указано, значение по умолчанию равно дню. | No |
| orderby | строка | Инструкция, которая упорядочивает значения результирующих данных для каждого приобретения. Синтаксис — orderby=field [order], field [order],... Параметр поля может быть одной из следующих строк:
|
No |
| Groupby | строка | Инструкция, которая применяет агрегирование данных только к указанным полям. Можно указать следующие поля:
|
No |
Пример запроса
В следующем примере показано несколько запросов на получение данных о приобретении игр 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>
Response
Текст ответа
| Значение | Тип | Описание |
|---|---|---|
| Значение | array | Массив объектов, содержащих статистические данные о приобретении для игры. Дополнительные сведения о данных в каждом объекте см . в разделе "Значения приобретения" ниже. |
| TotalCount | integer | Общее количество строк в результатах данных для запроса. |
Значения приобретения
Элементы в массиве значений содержат следующие значения.
| Значение | Тип | Описание |
|---|---|---|
| Дата | строка | Первая дата в диапазоне дат для данных приобретения. Если запрос указал один день, это значение равно дате. Если запрос указал неделю, месяц или другой диапазон дат, это значение является первой датой в этом диапазоне дат. |
| applicationId | строка | Идентификатор продукта игры Xbox One, для которой вы извлеките данные о приобретении. |
| applicationName | строка | Отображаемое имя игры. |
| acquisitionType | строка | Одна из следующих строк, указывающих тип приобретения:
|
| возраст | строка | Одна из следующих строк, указывающая возрастную группу пользователя, который сделал приобретение:
|
| deviceType | строка | Одна из следующих строк, указывающая тип устройства, завершив приобретение:
|
| пол | строка | Одна из следующих строк, указывающая пол пользователя, который сделал приобретение:
|
| на рынок | строка | Код страны ISO 3166 рынка, на котором произошло приобретение. |
| osVersion | строка | Версия ОС, в которой произошло приобретение. Для этого метода это значение всегда равно Windows 10 или Windows 11. |
| paymentInstrumentType | строка | Одна из следующих строк, указывающих инструкцию по оплате, используемую для приобретения:
|
| sandboxId | строка | Идентификатор песочницы, созданный для игры. Это может быть значение RETAIL или частный идентификатор песочницы. |
| storeClient | строка | Одна из следующих строк, указывающая версию Магазина, в которой произошло приобретение:
|
| xboxTitleId | строка | Идентификатор заголовка Xbox Live (представлен в шестнадцатеричном значении), назначенный порталом разработчика Xbox (XDP) для игр с поддержкой Xbox Live. |
| acquisitionQuantity | number | Количество приобретений, произошедших во время указанного уровня агрегирования. |
| purchasePriceUSDAmount | number | Сумма, выплачиваемая клиентом за приобретение, преобразованная в доллары США, с использованием ежемесячного курса обмена. |
| purchaseTaxUSDAmount | number | Сумма налога, примененная к приобретению, преобразованная в USD. |
| localCurrencyCode | строка | Код локальной валюты на основе страны учетной записи Центра партнеров. |
| xboxProductId | строка | Идентификатор продукта Xbox из XDP, если это применимо. |
| availabilityId | строка | Идентификатор доступности продукта из XDP, если применимо. |
| skuId | строка | Идентификатор SKU продукта из XDP, если это применимо. |
| skuDisplayName | строка | Отображаемое имя SKU продукта из XDP, если применимо. |
| xboxParentProductId | строка | Идентификатор родительского продукта Xbox из XDP, если это применимо. |
| parentProductName | строка | Имя родительского продукта из XDP, если применимо. |
| productTypeName | строка | Имя типа продукта из XDP, если применимо. |
| purchaseTaxType | строка | При необходимости приобрести налоговый тип продукта из XDP. |
| purchasePriceLocalAmount | number | При необходимости приобрести локальную сумму продукта из XDP. |
| purchaseTaxLocalAmount | number | При необходимости приобрести налог на локальную сумму продукта из 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
}
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по