Получение дополнительных модулей

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

Предпосылки

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

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

Просьба

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

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

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

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

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

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

Параметр Тип Описание Обязательно
applicationId струна Идентификатор магазина приложения, для которого требуется получить данные о приобретении дополнений. Да
ИдентификаторПродуктаВПриложении струна Идентификатор хранилища надстройки, для которой требуется получить данные о приобретении. Да
Дата начала дата Дата начала диапазона дат получения данных о приобретении надстроек. Значение по умолчанию — текущая дата. нет
Дата окончания дата Конечная дата периода для извлечения данных о приобретении надстройки. Значение по умолчанию — текущая дата. нет
Верх инт Количество строк данных, возвращаемых в запросе. Максимальное значение и значение по умолчанию, если не указано значение 10000. Если в запросе есть больше строк, текст ответа содержит следующую ссылку, которую можно использовать для запроса следующей страницы данных. нет
пропустить инт Количество строк, пропускаемых в запросе. Используйте этот параметр для навигации по большим наборам данных. Например, top=10000 и skip=0 извлекает первые 10000 строк данных, top=10000 и skip=10000 извлекает следующие 10000 строк данных и т. д. нет
фильтр струна Одна или несколько инструкций, которые фильтруют строки в ответе. Для получения дополнительной информации см. раздел поля фильтрации ниже. нет
уровень агрегации струна Указывает диапазон времени, для которого требуется получить статистические данные. Может быть одной из следующих строк: день, неделя или месяц. Если не указано, значение по умолчанию равно дню. нет
сортировать по струна Утверждение, которое упорядочивает значения результирующих данных для каждого приобретения надстройки. Синтаксис — orderby=field [order], field [order],.... Параметр field может быть одной из следующих строк:
  • дата
  • Тип приобретения
  • возрастнаяГруппа
  • storeClient
  • пол
  • рынок
  • версия ОС
  • тип устройства
  • orderName

Параметр order является необязательным и может принимать значения asc или desc, чтобы указать порядок по возрастанию или по убыванию для каждого поля. Значение по умолчанию — asc.

Ниже приведен пример строки orderby: orderby=date,market

нет
ГруппаПо струна Инструкция, которая применяет агрегирование данных только к указанным полям. Можно указать следующие поля:
  • дата
  • applicationName
  • inAppProductName
  • Тип приобретения
  • возрастнаяГруппа
  • storeClient
  • пол
  • рынок
  • версия ОС
  • тип устройства
  • orderName

Возвращаемые строки данных будут содержать поля, указанные в параметре groupby , а также следующие:

  • дата
  • applicationId
  • inAppProductId
  • количество приобретения

Параметр groupby можно использовать с параметром aggregationLevel . Например: &groupby=ageGroup,market&aggregationLevel=week

нет

Фильтрация полей

Параметр фильтра запроса содержит одну или несколько инструкций, которые фильтруют строки в ответе. Каждое утверждение содержит поле и значение, которые связаны с операторами 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')

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

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

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

В следующих примерах демонстрируются несколько запросов на получение данных о приобретении дополнений. Замените значения 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>

Ответ

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

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

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

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

Ценность Тип Описание
дата струна Первая дата в диапазоне дат для данных сбора. Если запрос указал один день, это значение равно дате. Если запрос указал неделю, месяц или другой диапазон дат, это значение является первой датой в этом диапазоне дат.
ИдентификаторПродуктаВПриложении струна Идентификатор в магазине для дополнения, для которого извлекаются данные о приобретении.
название продукта в приложении струна Отображаемое имя дополнения. Это значение отображается только в данных ответа, если параметр агрегированияLevel имеет значение день, если в параметре groupby не указано поле inAppProductName.
applicationId струна Идентификатор магазина для приложения, для которого требуется получить данные о приобретении надстроек.
название приложения струна Отображаемое имя приложения.
тип устройства струна Тип устройства, завершившего процесс приобретения. Список поддерживаемых строк см. в разделе поля фильтра выше.
названиеЗаказа струна Название заказа.
storeClient струна версия магазина, в которой произошло приобретение. Список поддерживаемых строк см. в разделе поля фильтра выше.
Версия ОС струна Версия ОС, в которой произошло приобретение. Список поддерживаемых строк см. в разделе поля фильтра выше.
рынок струна Код страны ISO 3166 рынка, на котором произошло приобретение.
гендер струна Пол пользователя, который сделал приобретение. Список поддерживаемых строк см. в разделе поля фильтра выше.
возрастная группа струна Возрастная группа пользователя, который сделал приобретение. Список поддерживаемых строк см. в разделе поля фильтра выше.
Тип приобретения струна Тип приобретения (бесплатный, платный и т. д.). Список поддерживаемых строк см. в разделе поля фильтра выше.
количество приобретения целое число Количество приобретений, которые произошли.

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

В следующем фрагменте кода показан пример текста запроса и текста ответа 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"
}