Получение сведений о покупках надстройки

Статья
01/10/2024

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

Необходимые компоненты

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

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

Запросить

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

Способ	URI запроса
GET	`https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions`

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

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

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

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

Параметр	Тип	Описание	Обязательное поле
applicationId	строка	Идентификатор приложения, для которого требуется получить данные о приобретении надстроек.	Да
inAppProductId	строка	Идентификатор магазина надстройки, для которой требуется получить данные о приобретении.	Да
startDate	Дата	Дата начала в диапазоне дат получения данных получения надстроек. Значение по умолчанию — текущая дата.	No
endDate	Дата	Дата окончания в диапазоне дат получения данных о приобретении надстройки. Значение по умолчанию — текущая дата.	No
популярное	INT	Количество строк данных, возвращаемых в запросе. Максимальное значение и значение по умолчанию, если не указано значение 10000. Если в запросе есть больше строк, текст ответа содержит следующую ссылку, которую можно использовать для запроса следующей страницы данных.	No
skip	INT	Количество строк, пропускаемых в запросе. Используйте этот параметр для страницы с помощью больших наборов данных. Например, top=10000 и skip=0 извлекает первые 10000 строк данных, top=10000 и skip=10000 извлекает следующие 10000 строк данных и т. д.	No
Фильтр	строка	Одна или несколько инструкций, которые фильтруют строки в ответе. Дополнительные сведения см. в разделе полей фильтра ниже.	No
aggregationLevel	строка	Указывает диапазон времени, для которого требуется получить статистические данные. Может быть одной из следующих строк: день, неделя или месяц. Если не указано, значение по умолчанию равно дню.	No
orderby	строка	Инструкция, которая упорядочивает значения результирующих данных для каждого приобретения надстройки. Синтаксис — orderby=field [order], field [order],.... Параметр поля может быть одной из следующих строк: date acquisitionType ageGroup storeClient пол рынок osVersion deviceType orderName Параметр order является необязательным и может быть asc или desc , чтобы указать возрастание или убывание для каждого поля. Значение по умолчанию — asc. Ниже приведен пример строки заказа : orderby=date,market	No
groupby	строка	Инструкция, которая применяет агрегирование данных только к указанным полям. Можно указать следующие поля: date applicationName inAppProductName acquisitionType ageGroup storeClient пол рынок osVersion deviceType orderName Возвращаемые строки данных будут содержать поля, указанные в параметре groupby , а также следующие: date applicationId inAppProductId acquisitionQuantity Параметр groupby можно использовать с параметром aggregationLevel . Например: &groupby=ageGroup,market&aggregationLevel=week	No

Поля фильтра

Параметр фильтра запроса содержит одну или несколько инструкций, которые фильтруют строки в ответе. Каждая инструкция содержит поле и значение, связанное с операторами eq или ne, и операторы могут объединяться с помощью или или. Ниже приведены некоторые примеры параметров фильтра :

filter=market eq 'US' и gender eq 'm'
filter=(market ne 'US') и (gender ne 'Unknown') и (gender ne 'm') и (market ne 'NO') и (ageGroup ne 'больше 55' или ageGroup ne 'менее 13')

Список поддерживаемых полей см. в следующей таблице. Строковые значения должны быть окружены одними кавычками в параметре фильтра .

Поля	Description
acquisitionType	Одна из следующих строк: free испытание оплачиваемый рекламный код iap
ageGroup	Одна из следующих строк: менее 13 13-17 18-24 25-34 35-44 44-55 больше 55 Unknown
storeClient	Одна из следующих строк: Магазин Windows Phone (клиент) Microsoft Store (клиент) Microsoft Store (веб-сайт) Приобретение томов организациями Другое
пол	Одна из следующих строк: m f Unknown
на рынок	Строка, содержащая код страны ISO 3166 рынка, на котором произошло приобретение.
osVersion	Одна из следующих строк: Windows Phone 7.5 Windows Phone 8 Windows Phone 8.1 Windows Phone 10 Windows 8 Windows 8.1 Windows 10 Windows 11 Unknown
deviceType	Одна из следующих строк: ПК Для телефонов Console-Xbox One Серия Xbox X консоли Интернет вещей Голографический Unknown
orderName	Строка, указывающая имя заказа для рекламного кода, который использовался для получения надстройки (это применяется только в том случае, если пользователь приобрел надстройку путем активации рекламного кода).

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?inAppProductId=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/inappacquisitions?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/inappacquisitions?inAppProductId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=7/3/2015&top=100&skip=0&filter=market ne 'US' and gender ne 'Unknown' and gender ne 'm' and market ne 'NO' and ageGroup ne '>55' HTTP/1.1
Authorization: Bearer <your access token>

Response

Текст ответа

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

Значения приобретения надстроек

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

Значение	Тип	Описание
Дата	строка	Первая дата в диапазоне дат для данных приобретения. Если запрос указал один день, это значение равно дате. Если запрос указал неделю, месяц или другой диапазон дат, это значение является первой датой в этом диапазоне дат.
inAppProductId	строка	Идентификатор магазина надстройки, для которой извлекаются данные о приобретении.
inAppProductName	строка	Отображаемое имя надстройки. Это значение отображается только в данных ответа, если параметр aggregationLevel имеет значение day, если в параметре groupby не указано поле inAppProductName.
applicationId	строка	Идентификатор приложения, для которого требуется получить данные о приобретении надстроек.
applicationName	строка	Отображаемое имя приложения.
deviceType	строка	Тип устройства, завершив приобретение. Список поддерживаемых строк см. в разделе "Поля фильтра" выше.
orderName	строка	Имя заказа.
storeClient	строка	Версия Магазина, в которой произошло приобретение. Список поддерживаемых строк см. в разделе "Поля фильтра" выше.
osVersion	строка	Версия ОС, в которой произошло приобретение. Список поддерживаемых строк см. в разделе "Поля фильтра" выше.
на рынок	строка	Код страны ISO 3166 рынка, на котором произошло приобретение.
пол	строка	Пол пользователя, который сделал приобретение. Список поддерживаемых строк см. в разделе "Поля фильтра" выше.
ageGroup	строка	Возрастная группа пользователя, который сделал приобретение. Список поддерживаемых строк см. в разделе "Поля фильтра" выше.
acquisitionType	строка	Тип приобретения (бесплатный, платный и т. д.). Список поддерживаемых строк см. в разделе "Поля фильтра" выше.
acquisitionQuantity	integer	Количество приобретений, которые произошли.

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

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>

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

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Deluxe Collector's Edition",
            "addonProductId": "9NBLGGAAGZDQ",
            "date": "2022-07-29",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 18.12,
            "purchasePriceLocalAmount": 18.12,
            "purchaseTaxUSDAmount": 1.13,
            "purchaseTaxLocalAmount": 1.13
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Episode 4",
            "addonProductId": "9NAAAAAAAAAQ",
            "date": "2017-01-07",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 4.147206,
            "purchasePriceLocalAmount": 3.99,
            "purchaseTaxUSDAmount": 0.686004,
            "purchaseTaxLocalAmount": 0.66
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Deluxe Collector's Edition",
            "addonProductId": "9NALGGGZ5QDQ",
            "date": "2018-04-01",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 1.99,
            "purchasePriceLocalAmount": 1.99,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Strategy Guide Episode 4",
            "addonProductId": "9NBLGGGZ5QDQ",
            "date": "2021-11-25",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 1.31902922876179,
            "purchasePriceLocalAmount": 150.0,
            "purchaseTaxUSDAmount": 0.114315866492689,
            "purchaseTaxLocalAmount": 13.0
        },
    ],
    "TotalCount": 4,
    "DataFreshnessTimestamp": "2022-07-29T05:54:00"
}

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

Получение сведений о покупках надстройки

Необходимые компоненты

Запросить

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

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

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

Поля фильтра

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

Response

Текст ответа

Значения приобретения надстроек

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

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

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

Обратная связь

Дополнительные ресурсы

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

Получение сведений о покупках надстройки

Необходимые компоненты

Запросить

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

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

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

Поля фильтра

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

Response

Текст ответа

Значения приобретения надстроек

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

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

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

См. также

Обратная связь

Дополнительные ресурсы