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

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

Предпосылки

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

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

Просьба

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

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

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

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

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

Параметр Тип Описание Обязательно
applicationId струна Идентификатор магазина приложения, для которого требуется получить данные воронки покупок. Пример идентификатора магазина — 9WZDNCRFJ3Q8. Да
Дата начала дата Дата начала в диапазоне дат получения данных воронки приобретения. Значение по умолчанию — текущая дата. нет
Дата окончания дата Дата окончания в диапазоне дат получения данных воронки приобретения. Значение по умолчанию — текущая дата. нет
фильтр струна Одна или несколько инструкций, которые фильтруют строки в ответе. Для получения дополнительной информации см. раздел поля фильтрации ниже. нет

 

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

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

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

Поля Описание
идентификатор кампании Идентификатор строки для кампании по продвижению настраиваемых приложений, связанной с приобретением.
рынок Строка, содержащая код страны ISO 3166 рынка, на котором произошло приобретение.
тип устройства Одна из следующих строк, указывающая тип устройства, на котором произошло приобретение:
  • ПК
  • Телефон
  • Console-Xbox One
  • Консоль Xbox Series X
  • Интернет вещей
  • Голографический
  • Неизвестный
возрастная группа Одна из следующих строк, указывающая возрастную группу пользователя, завершившего приобретение:
  • 0 – 17
  • 18 – 24
  • 25 – 34
  • 35 – 49
  • 50 или более
  • Неизвестный
гендер Одна из следующих строк, указывающая пол пользователя, завершившего приобретение:
  • M
  • Ф
  • Неизвестный

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

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

Ответ

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

Ценность Тип Описание
Ценность массив Массив объектов, содержащих данные о воронке проникновения приложения. Дополнительные сведения о данных в каждом объекте см. в разделе «Значения воронки» ниже.
Общее количество инт Общее количество объектов в массиве значений .

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

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

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

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

В следующих фрагментах кода показан пример текста запроса и текста ответа 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": "Acquisition",
            "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": "Acquisition",
            "UserCount": 8
        },
        {
            "MetricType": "Usage",
            "UserCount": 5
        },
        {
            "MetricType": "Install",
            "UserCount": 3
        }
    ],
    "TotalCount": 4
}