Получение данных о приобретении надстроек для игр и приложенийGet add-on acquisitions data for your games and apps

Используйте этот метод в API Microsoft Store Analytics для получения статистических данных о приобретении надстроек в формате JSON для приложений UWP и Xbox One Games, которые были получены через портал разработчика Xbox (КСДП) и доступны на панели мониторинга центра партнеров КСДП Analytics.Use this method in the Microsoft Store analytics API to get aggregate add-on acquisition data in JSON format for UWP apps and Xbox One games that were ingested through the Xbox Developer Portal (XDP) and available in the XDP Analytics Partner Center dashboard.

Предварительные требованияPrerequisites

Для использования этого метода сначала необходимо сделать следующее:To use this method, you need to first do the following:

  • Если вы еще не сделали этого, выполните все необходимые условия для API аналитики для Microsoft Store.If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
  • Получите маркер доступа Azure AD, который будет использоваться в заголовке запроса этого метода.Obtain an Azure AD access token to use in the request header for this method. После получения маркера доступа у вас будет 60 минут, чтобы использовать его до истечения срока действия.After you obtain an access token, you have 60 minutes to use it before it expires. После истечения срока действия маркера можно получить новый маркер.After the token expires, you can obtain a new one.

Примечание

Этот API не предоставляет ежедневные статистические данные до 1 октября 2016.This API does not provide daily aggregate data before Oct 1st 2016.

ЗапросRequest

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

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/addonacquisitions

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

ЗаголовокHeader ТипType ОписаниеDescription
АвторизацияAuthorization строкаstring Обязательный элемент.Required. Маркер доступа Azure AD в формате носителя <token> .The Azure AD access token in the form Bearer <token>.

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

Параметр applicationId или аддонпродуктид является обязательным.The applicationId or addonProductId parameter is required. Для извлечения данных о покупках всех надстроек, зарегистрированных в приложении, укажите параметр applicationId.To retrieve acquisition data for all add-ons registered to the app, specify the applicationId parameter. Чтобы получить данные о приобретении для одной надстройки, укажите параметр аддонпродуктид .To retrieve acquisition data for a single add-on, specify the addonProductId parameter. Если указаны оба параметра, параметр applicationId игнорируется.If you specify both, the applicationId parameter is ignored.

ПараметрParameter ТипType ОписаниеDescription Обязательное значениеRequired
applicationIdapplicationId строкаstring ProductID для игры Xbox One, для которого извлекаются данные о приобретении.The productId of the Xbox One game for which you are retrieving acquisition data. Чтобы получить код продукта для игры, перейдите к игре в программе КСДП Analytics и извлеките ProductID из URL-адреса.To get the productId of your game, navigate to your game in the XDP Analytics Program and retrieve the productId from the URL. Кроме того, если вы скачиваете данные о приобретении из аналитического отчета центра партнеров, то ProductID включается в TSV-файл.Alternatively, if you download your acquisitions data from the Partner Center analytics report, the productId is included in the .tsv file. ДаYes
аддонпродуктидaddonProductId строкаstring ProductID надстройки, для которой необходимо получить данные о приобретении.The productId of the add-on for which you want to retrieve acquisition data. ДаYes
startDatestartDate Датаdate Начальная дата диапазона дат, для которого требуется получить данные о покупках надстройки.The start date in the date range of add-on acquisition data to retrieve. По умолчанию используется текущая дата.The default is the current date. НетNo
endDateendDate Датаdate Конечная дата диапазона дат, для которого требуется получить данные о покупках надстройки.The end date in the date range of add-on acquisition data to retrieve. По умолчанию используется текущая дата.The default is the current date. нетNo
toptop INTint Количество строк данных, возвращаемых в запросе.The number of rows of data to return in the request. Максимальное значение и значение по умолчанию (если параметр не указан) — 10 000.The maximum value and the default value if not specified is 10000. Если в запросе содержится больше строк, то тело ответа будет содержать ссылку «Далее», которую можно использовать для запроса следующей страницы данныхIf there are more rows in the query, the response body includes a next link that you can use to request the next page of data. НетNo
skipskip INTint Количество строк, пропускаемых в запросе.The number of rows to skip in the query. Используйте этот параметр для постраничного перемещения по большим наборам данных.Use this parameter to page through large data sets. Например, при top=10000 и skip=0 извлекаются первые 10 000 строк данных; при top=10000 и skip=10000 извлекаются следующие 10 000 строк данных и т. д.For example, top=10000 and skip=0 retrieves the first 10000 rows of data, top=10000 and skip=10000 retrieves the next 10000 rows of data, and so on. НетNo
фильтрfilter строкаstring Одно или несколько выражений для фильтрации строк в ответе.One or more statements that filter the rows in the response. Каждое выражение содержит имя поля из тела ответа и значение, которое связано с помощью операторов eq или ne; выражения можно комбинировать, используя операторы and или or.Each statement contains a field name from the response body and value that are associated with the eq or ne operators, and statements can be combined using and or or. В параметре filter строковые значения должны быть заключены в одиночные кавычки.String values must be surrounded by single quotes in the filter parameter. Например, filter=market eq 'US' and gender eq 'm'.For example, filter=market eq 'US' and gender eq 'm'.
Вы можете указать следующие поля из тела ответа:You can specify the following fields from the response body:
  • Тип приобретенияacquisitionType
  • интервалage
  • storeClientstoreClient
  • gendergender
  • звонкmarket
  • osVersionosVersion
  • Типа устройстваdeviceType
  • sandboxIdsandboxId
НетNo
aggregationLevelaggregationLevel строкаstring Определяет диапазон времени, для которого требуется получить сводные данные.Specifies the time range for which to retrieve aggregate data. Можно использовать следующие строки: day, week или month.Can be one of the following strings: day, week, or month. Если параметр не задан, значение по умолчанию — day.If unspecified, the default is day. НетNo
orderbyorderby строкаstring Оператор, который определяет порядок полученных значений данных для каждой покупки надстройки.A statement that orders the result data values for each add-on acquisition. Синтаксис — OrderBy = поле [порядок], поле [порядок],... Параметр field может быть одной из следующих строк:The syntax is orderby=field [order],field [order],... The field parameter can be one of the following strings:
  • datedate
  • Тип приобретенияacquisitionType
  • интервалage
  • storeClientstoreClient
  • gendergender
  • звонкmarket
  • osVersionosVersion
  • Типа устройстваdeviceType
  • orderNameorderName
Параметр order является необязательным и может принимать значения asc или desc, которые указывают, соответственно, порядок сортировки по возрастанию или по убыванию для каждого поля.The order parameter is optional, and can be asc or desc to specify ascending or descending order for each field. Значение по умолчанию — ASC.The default is asc.
Ниже приведен пример строки OrderBy : OrderBy = Дата, рыночнаяHere is an example orderby string: orderby=date,market
НетNo
groupbygroupby строкаstring Выражение, которое применяет агрегирование данных только к указанным полям.A statement that applies data aggregation only to the specified fields. Можно указать следующие поля:You can specify the following fields:
  • datedate
  • applicationNameapplicationName
  • аддонпродуктнамеaddonProductName
  • Тип приобретенияacquisitionType
  • интервалage
  • storeClientstoreClient
  • gendergender
  • звонкmarket
  • osVersionosVersion
  • Типа устройстваdeviceType
  • paymentInstrumentTypepaymentInstrumentType
  • sandboxIdsandboxId
  • xboxTitleIdHexxboxTitleIdHex
Возвращенные строки данных будут содержать поля, указанные в параметре groupby, а также:The returned data rows will contain the fields specified in the groupby parameter as well as the following:
  • datedate
  • applicationIdapplicationId
  • аддонпродуктидaddonProductId
  • acquisitionQuantityacquisitionQuantity
Параметр groupby можно использовать вместе с параметром aggregationLevel.The groupby parameter can be used with the aggregationLevel parameter. Например: &GroupBy = Age, datamarket&аггрегатионлевел = Week .For example: &groupby=age,market&aggregationLevel=week
НетNo

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

В следующих примерах демонстрируются несколько запросов на получение информации о покупках надстройки.The following examples demonstrates several requests for getting add-on acquisition data. Замените значения аддонпродуктид и applicationId соответствующими идентификаторами хранилища для надстройки или приложения.Replace the addonProductId and applicationId values with the appropriate Store ID for your add-on or app.

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

Authorization: Bearer <your access token>

ОтветResponse

Текст ответаResponse body

ЗначениеValue ТипType ОписаниеDescription
ЗначениеValue arrayarray Массив объектов, содержащий сводную информацию о покупках надстройки.An array of objects that contain aggregate add-on acquisition data. Дополнительные сведения о данных в каждом объекте см. далее в разделе Значения информации о покупке надстройки.For more information about the data in each object, see the add-on acquisition values section below.
@nextLink строкаstring При наличии дополнительных страниц данных эта строка содержит универсальный код ресурса (URI), который можно использовать для запроса следующей страницы данных.If there are additional pages of data, this string contains a URI that you can use to request the next page of data. Например, это значение возвращается в том случае, если параметр top запроса имеет значение 10 000, но для данного запроса имеется больше 10 000 строк с информацией о покупках надстроек.For example, this value is returned if the top parameter of the request is set to 10000 but there are more than 10000 rows of add-on acquisition data for the query.
TotalCountTotalCount INTint Общее количество строк в результирующих данных для запроса.The total number of rows in the data result for the query.

Значения информации о покупке надстройкиAdd-on acquisition values

Элементы в массиве Value содержат следующие значения.Elements in the Value array contain the following values.

ЗначениеValue ТипType ОписаниеDescription
Датаdate строкаstring Первая дата в диапазоне дат, для которого требуется получить данные о покупках.The first date in the date range for the acquisition data. Если в запросе указан один день, это значение равно дате, соответствующей тому дню.If the request specified a single day, this value is that date. Если запрос указывает неделю, месяц или другой диапазон дат, это значение равно первой дате в этом диапазоне дат.If the request specified a week, month, or other date range, this value is the first date in that date range.
аддонпродуктидaddonProductId строкаstring ProductID надстройки, для которой извлекаются данные о приобретении.The productId of the add-on for which you are retrieving acquisition data.
аддонпродуктнамеaddonProductName строкаstring Отображаемое имя надстройки.The display name of the add-on. Это значение отображается в ответных данных, если для параметра аггрегатионлевел задано значение Day, если только не указано поле аддонпродуктнаме в параметре GroupBy .This value only appears in the response data if the aggregationLevel parameter is set to day, unless you specify the addonProductName field in the groupby parameter.
applicationIdapplicationId строкаstring ProductID приложения, для которого требуется получить данные о приобретении надстройки.The productId of the app for which you want to retrieve add-on acquisition data.
applicationNameapplicationName строкаstring Отображаемое имя игры.The display name of the game.
deviceTypedeviceType строкаstring Одна из следующих строк, указывающая тип устройства, на котором было выполнено приобретение:One of the following strings that specifies the type of device that completed the acquisition:
  • ACPI"PC"
  • Факс"Phone"
  • "Консоль — Xbox One""Console-Xbox One"
  • "Консоль — Xbox серии X""Console-Xbox Series X"
  • IOT"IoT"
  • Сервером"Server"
  • Помощью"Tablet"
  • Holographic"Holographic"
  • Неизвестный"Unknown"
storeClientstoreClient строкаstring Одна из следующих строк, указывающая версию Store, где совершено приобретение:One of the following strings that indicates the version of the Store where the acquisition occurred:
  • "Хранилище Windows Phone (клиент)""Windows Phone Store (client)"
  • "Microsoft Store (клиент)" (или "Магазин Windows (клиент)" при запросе данных до 23 марта 2018)"Microsoft Store (client)" (or "Windows Store (client)" if querying for data before March 23, 2018)
  • "Microsoft Store (веб)" (или "Магазин Windows (Интернет)" при запросе данных до 23 марта 2018)"Microsoft Store (web)" (or "Windows Store (web)" if querying for data before March 23, 2018)
  • "Покупка корпоративных продаж по организациям""Volume purchase by organizations"
  • Иной"Other"
osVersionosVersion строкаstring Версия ОС, в которой произведена покупка.The OS version on which the acquisition occurred. Для этого метода это значение всегда равно "Windows 10".For this method, this value is always "Windows 10".
marketmarket строкаstring Код страны по стандарту ISO 3166 для рынка, на котором произошла покупкаThe ISO 3166 country code of the market where the acquisition occurred.
gendergender строкаstring Одна из следующих строк, указывающая пол пользователя, совершившего приобретение:One of the following strings that specifies the gender of the user who made the acquisition:
  • "m""m"
  • "f""f"
  • Неизвестный"Unknown"
ageage строкаstring Одна из следующих строк, указывающая возрастную группу пользователя, совершившего приобретение:One of the following strings that indicates the age group of the user who made the acquisition:
  • "меньше 13""less than 13"
  • "13-17""13-17"
  • "18-24""18-24"
  • "25-34""25-34"
  • "35-44""35-44"
  • "44-55""44-55"
  • "больше 55""greater than 55"
  • Неизвестный"Unknown"
Тип приобретенияacquisitionType строкаstring Одна из следующих строк, указывающих тип приобретения:One of the following strings that indicates the type of acquisition:
  • Свободный"Free"
  • ПК"Trial"
  • Сделан"Paid"
  • "Рекламный код""Promotional code"
  • IAP"Iap"
  • "Подписка IAP""Subscription Iap"
  • "Частная аудитория""Private Audience"
  • "Предварительный порядок""Pre Order"
  • "Начать игру с Xbox" (или "прохождение игры", если запрашивать данные до 23 марта 2018)"Xbox Game Pass" (or "Game Pass" if querying for data before March 23, 2018)
  • Свободного"Disk"
  • "Предварительно оплаченный код""Prepaid Code"
  • "Предварительная оплата с оплатой""Charged Pre Order"
  • "Отмененный предварительный порядок""Cancelled Pre Order"
  • "Невыполненный предварительный порядок""Failed Pre Order"
acquisitionQuantityacquisitionQuantity Целое числоinteger Количество покупок.The number of acquisitions that occurred.
inAppProductIdinAppProductId строкаstring Идентификатор продукта, в котором используется эта надстройка.Product ID of the product where this add-on is used.
inAppProductNameinAppProductName строкаstring Название продукта, в котором используется эта надстройка.Product Name of the product where this add-on is used.
paymentInstrumentTypepaymentInstrumentType строкаstring Тип платежного инструмента, используемого для приобретения.Payment instrument type used for the acquisition.
sandboxIdsandboxId строкаstring ИДЕНТИФИКАТОР "песочницы", созданный для игры.The Sandbox ID created for the game. Это может быть значение " розничная сеть " или "частный" идентификатор "песочницы".This can be the value RETAIL or a private sandbox ID.
ксбокститлеидxboxTitleId строкаstring ИДЕНТИФИКАТОР заголовка Xbox продукта из КСДП, если применимо.Xbox Title ID of the product from XDP, if applicable.
локалкурренцикодеlocalCurrencyCode строкаstring Код местной валюты на основе страны учетной записи центра партнеров.Local Currency code based on the country of the Partner Center account.
ксбокспродуктидxboxProductId строкаstring Идентификатор продукта Xbox из КСДП, если применимо.Xbox Product ID of the product from XDP, if applicable.
availabilityIdavailabilityId строкаstring ИДЕНТИФИКАТОР доступности продукта из КСДП, если применимо.Availability ID of the product from XDP, if applicable.
skuIdskuId строкаstring Идентификатор SKU продукта из КСДП, если применимо.SKU ID of the product from XDP, if applicable.
скудисплайнамеskuDisplayName строкаstring Отображаемое имя SKU продукта с КСДП, если применимо.SKU Display Name of the product from XDP, if applicable.
ксбокспарентпродуктидxboxParentProductId строкаstring Родительский идентификатор продукта Xbox из КСДП, если применимо.Xbox Parent Product ID of the product from XDP, if applicable.
parentProductNameparentProductName строкаstring Имя родительского продукта продукта из КСДП, если применимо.Parent Product Name of the product from XDP, if applicable.
продукттипенамеproductTypeName строкаstring Имя типа продукта для продукта из КСДП, если применимо.Product Type Name of the product from XDP, if applicable.
пурчасетакстипеpurchaseTaxType строкаstring Тип налога на продукт с КСДП, если применимо.Purchase Tax Type of the product from XDP, if applicable.
purchasePriceUSDAmountpurchasePriceUSDAmount numbernumber Сумма, выплаченная клиентом для надстройки, преобразованная в USD.The amount paid by the customer for the add-on, converted to USD.
пурчасеприцелокаламаунтpurchasePriceLocalAmount numbernumber Сумма налогов, применяемая к надстройке.The tax amount applied to the add-on.
пурчасетаксусдамаунтpurchaseTaxUSDAmount numbernumber Сумма налогов, применяемая к надстройке, преобразованная в USD.The tax amount applied to the add-on, converted to USD.
пурчасетакслокаламаунтpurchaseTaxLocalAmount numbernumber Покупка местного налога на продукт с КСДП, если применимо.Purchase Tax Local Amount of the product from XDP, if applicable.

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

В следующем примере демонстрируется пример тела ответа JSON на данный запрос.The following example demonstrates an example JSON response body for this request.

{ 
  "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 
}