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

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

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

Для использования этого метода сначала необходимо сделать следующее:

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

Запрос

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

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

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

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

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

Параметр Тип Описание Обязательно
applicationId строка Код продукта в Магазине для приложения, по которому требуется получить данные о воронке приобретений. Пример кода продукта в Магазине: 9WZDNCRFJ3Q8 Да
startDate Дата Начальная дата диапазона дат, для которого требуется получить данные о воронке приобретений. По умолчанию используется текущая дата. Нет
endDate Дата Конечная дата диапазона дат, для которого требуется получить данные о воронке приобретений. По умолчанию используется текущая дата. Нет
фильтр строка Одно или несколько выражений для фильтрации строк в ответе. Дополнительные сведения см. далее в разделе фильтрация полей Нет

 

Поля фильтра

Параметр filter запроса содержит один или несколько операторов, фильтрующих строки в ответе. Каждый оператор содержит поле и значение, которые связаны с операторами выражения eq или ne; операторы можно комбинировать с помощью and или or.

Поддерживаются следующие поля фильтра. В параметре filter строковые значения должны быть заключены в одиночные кавычки.

Поля Описание
campaignId Строка идентификатора для пользовательской кампании по продвижению приложения, связанной с этим приобретением.
market Строка, содержащая код страны по стандарту ISO 3166 для рынка, на котором произошла покупка
deviceType Одна из следующих строк, указывающая тип устройства, на котором совершено приобретение:
  • PC
  • Номер телефона
  • Консоль Xbox One
  • Консоль Xbox Серии X
  • Интернет вещей
  • Holographic (голография),
  • Unknown
ageGroup Одна из следующих строк, указывающая возрастную группу пользователя, совершившего приобретение:
  • 0–17
  • 18–24
  • 25–34
  • 35–49
  • 50 и более
  • Unknown
gender Одна из следующих строк, указывающая пол пользователя, совершившего приобретение:
  • M
  • Ж
  • Unknown

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel?applicationId=9NBLGGGZ5QDR&startDate=1/1/2017&endDate=2/1/2017  HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel?applicationId=9NBLGGGZ5QDR&startDate=8/1/2016&endDate=8/31/2016&filter=market eq 'US' and gender eq 'm'  HTTP/1.1
Authorization: Bearer <your access token>

Ответ

Текст ответа

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

Значения воронки

Объекты в массиве Value содержат следующие значения.

Значение Тип Описание
MetricType строка Одна из следующих строк, задающих тип данных воронки, включенный в этот объект:
  • ВидСтраницы
  • Получение
  • Установка
  • Использование
UserCount строка Количество пользователей, которые выполнили шаг воронки, определяемый значением MetricType.

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

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

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

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

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

{
    "Value": [
        {
            "MetricType": "PageView",
            "UserCount": 6214
        },
        {
            "MetricType": "Acqusition",
            "UserCount": 1502
        },
        {
            "MetricType": "Usage",
            "UserCount": 606
        },
        {
            "MetricType": "Install",
            "UserCount": 977
        }
    ],
    "TotalCount": 4
}

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel?applicationId=9NBLGGGZ5QDR&startDate=12/19/2021&endDate=12/21/2021&filter=market eq 'US' and gender eq 'm'
HTTP/1.1
Authorization: Bearer <your access token>

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

{
    "Value": [
        {
            "MetricType": "PageView",
            "UserCount": 10
        },
        {
            "MetricType": "Acqusition",
            "UserCount": 8
        },
        {
            "MetricType": "Usage",
            "UserCount": 5
        },
        {
            "MetricType": "Install",
            "UserCount": 3
        }
    ],
    "TotalCount": 4
}