Получение данных воронки приобретений приложения
Используйте этот метод в 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 | Дата | Дата начала в диапазоне дат получения данных воронки приобретения. Значение по умолчанию — текущая дата. | No |
endDate | Дата | Дата окончания в диапазоне дат получения данных воронки приобретения. Значение по умолчанию — текущая дата. | No |
Фильтр | строка | Одна или несколько инструкций, которые фильтруют строки в ответе. Дополнительные сведения см. в разделе полей фильтра ниже. | No |
Поля фильтра
Параметр фильтра запроса содержит одну или несколько инструкций, которые фильтруют строки в ответе. Каждая инструкция содержит поле и значение, связанное с операторами eq или ne, и операторы могут объединяться с помощью или или.
Поддерживаются следующие поля фильтров. Строковые значения должны быть окружены одними кавычками в параметре фильтра .
Поля | Description |
---|---|
campaignId | Строка идентификатора для пользовательской кампании по продвижению приложений, связанной с приобретением. |
на рынок | Строка, содержащая код страны ISO 3166 рынка, на котором произошло приобретение. |
deviceType | Одна из следующих строк, указывающая тип устройства, на котором произошло приобретение:
|
ageGroup | Одна из следующих строк, указывающая возрастную группу пользователя, завершившего приобретение:
|
пол | Одна из следующих строк, указывающая пол пользователя, завершившего приобретение:
|
Пример запроса
В следующем примере показано несколько запросов на получение данных воронки приобретения для приложения. Замените значение 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>
Response
Текст ответа
Значение | Тип | Описание |
---|---|---|
Значение | array | Массив объектов, содержащих данные воронки приобретения для приложения. Дополнительные сведения о данных в каждом объекте см . в разделе "Воронки значений " ниже. |
TotalCount | INT | Общее количество объектов в массиве значений. |
Значения воронки
Объекты в массиве значений содержат следующие значения.
Значение | Тип | Описание |
---|---|---|
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": "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
}