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


Получение данных аналитики

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

Предпосылки

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

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

Просьба

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

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

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

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

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

Параметр Тип Описание Обязательно
applicationId струна Идентификатор магазина приложения, для которого требуется получить данные аналитики. Если этот параметр не указан, текст ответа будет содержать данные аналитики для всех приложений, зарегистрированных в вашей учетной записи. нет
Дата начала дата Дата начала в диапазоне дат данных аналитики, которые нужно получить. Значение по умолчанию — 30 дней до текущей даты. нет
Дата окончания дата Дата окончания в диапазоне дат для получения данных аналитики. Значение по умолчанию — текущая дата. нет
фильтр струна Одна или несколько инструкций, которые фильтруют строки в ответе. Каждое выражение содержит имя поля из текста ответа и значение, связанное с операторами eq или ne, и выражения могут быть объединены с помощью и или или. Строковые значения должны быть окружены одними кавычками в параметре фильтра . Например, filter=dataType eq 'acquisition'.

Можно указать следующие поля фильтра:

  • приобретение
  • Здоровье
  • употребление
Да

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/insights?applicationId=9NBLGGGZ5QDR&startDate=6/1/2018&endDate=6/15/2018&filter=dataType eq 'acquisition' or dataType eq 'health' HTTP/1.1
Authorization: Bearer <your access token>

Ответ

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

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

Значения аналитических сведений

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

Ценность Тип Описание
applicationId струна Идентификатор магазина приложения, для которого извлекаются данные аналитики.
Дата инсайта струна Дата, в которой мы определили изменение определенной метрики. Эта дата представляет конец недели, в которой мы обнаружили значительное увеличение или уменьшение метрики по сравнению с этой неделей.
тип данных струна Одна из следующих строк, указывающая общую область аналитики, описываемую этим аналитическим представлением:

  • приобретение
  • Здоровье
  • употребление
детали инсайта массив Одно или несколько значений InsightsDetail , представляющих сведения для текущего анализа.

Значения InsightDetail

Ценность Тип Описание
Название факта струна Одно из следующих значений, указывающее на метрику, которую описывают текущие выводы или текущее измерение на основе значения dataType.
  • Для здоровья это значение всегда равно HitCount.
  • Для приобретения это значение всегда является AcquisitionQuantity.
  • Для использования это значение может быть одной из следующих строк:
    • ЕжедневныеАктивныеПользователи
    • EngagementDurationMinutes (ВовлеченностьDurationMinutes)
    • DailyActiveDevices (Ежедневные активные устройства)
    • ЕжедневныеНовыеПользователи
    • Ежедневное количество сессий
Подразмерности массив Один или несколько объектов, описывающих одну метрику для анализа.
ИзменениеПроцента струна Процент изменения метрики по всей вашей клиентской базе.
НазваниеИзмерения струна Имя метрики, описанной в текущем измерении. Примерами являются EventType, Market, DeviceType, PackageVersion, AcquisitionType, AgeGroup и gender.
ЗначениеРазмерности струна Значение метрики, описанной в текущем измерении. Например, если DimensionNameEventType, DimensionValue может быть сбой или зависание.
ЗначениеФакта струна Абсолютное значение метрики на дату обнаружения аналитических сведений.
Направление струна Направление изменения (положительное или отрицательное).
Дата струна Дата, в которой мы определили изменение, связанное с текущим анализом или текущим измерением.

Замечание

Извлеченные изменения аналитики будут только охватывать последние 30 дней данных о закупках, работоспособности и/или использовании.

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

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/insights?applicationId=9NBLGGGZ5QDR&startDate=7/12/2022&endDate=7/29/2022&filter=dataType eq 'acquisition' or dataType eq 'health'
HTTP/1.1
Authorization: Bearer <your access token>

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

{
    "Value": [
        {
            "id": "8cdb672c7893bd33a3dec48ededdc676602a1361f3209ab4f3e0982672fc198f",
            "applicationId": "9NBLGGGZ5QDR",
            "insightDate": "2022-07-27T00:00:00",
            "dataType": "acquisition",
            "insightDetail": [
                {
                    "DimensionName": "AcquisitionType",
                    "DimensionValue": "Free",
                    "Date": "2022-07-27 00:00:00",
                    "FactName": "AcquisitionQuantity",
                    "SubDimensions": [
                        {
                            "DimensionName": "DeviceType",
                            "DimensionValue": "Tablet",
                            "Date": "2022-07-27 00:00:00",
                            "Direction": "Positive",
                            "PercentChange": 16.091954022988507,
                            "FactName": "AcquisitionQuantity",
                            "FactQuantity": 28.0
                        }
                    ]
                }
            ]
        },
        {
            "id": "6b8849ecb043c6e5ecdd1c20040c0a371e9ab176eff77f7312b0489e19379225",
            "applicationId": "9NBLGGGZ5QDR",
            "insightDate": "2022-07-26T00:00:00",
            "dataType": "acquisition",
            "insightDetail": [
                {
                    "DimensionName": "AcquisitionType",
                    "DimensionValue": "Free",
                    "Date": "2022-07-26 00:00:00",
                    "FactName": "AcquisitionQuantity",
                    "SubDimensions": [
                        {
                            "DimensionName": "DeviceType",
                            "DimensionValue": "Tablet",
                            "Date": "2022-07-26 00:00:00",
                            "Direction": "Positive",
                            "PercentChange": 28.048780487804876,
                            "FactName": "AcquisitionQuantity",
                            "FactQuantity": 30.0
                        }
                    ]
                }
            ]
        },
        {
            "id": "93115e855fec507385bab17251f49c33bcbc1b62c603e5c7863e327ba94bf160",
            "applicationId": "9NBLGGGZ5QDR",
            "insightDate": "2022-07-20T00:00:00",
            "dataType": "acquisition",
            "insightDetail": [
                {
                    "DimensionName": "AcquisitionType",
                    "DimensionValue": "Free",
                    "Date": "2022-07-20 00:00:00",
                    "FactName": "AcquisitionQuantity",
                    "SubDimensions": [
                        {
                            "DimensionName": "Market",
                            "DimensionValue": "GB",
                            "Date": "2022-07-20 00:00:00",
                            "Direction": "Negative",
                            "PercentChange": 3.3035714285714284,
                            "FactName": "AcquisitionQuantity",
                            "FactQuantity": 158.0
                        }
                    ]
                }
            ]
        },
        {
            "id": "4814abe710042a2798b453d8821909c246c389dde814e6678da7189211410604",
            "applicationId": "9NBLGGGZ5QDR",
            "insightDate": "2022-07-24T00:00:00",
            "dataType": "acquisition",
            "insightDetail": [
                {
                    "DimensionName": "AcquisitionType",
                    "DimensionValue": "Free",
                    "Date": "2022-07-24 00:00:00",
                    "FactName": "AcquisitionQuantity",
                    "SubDimensions": [
                        {
                            "DimensionName": "Market",
                            "DimensionValue": "DO",
                            "Date": "2022-07-24 00:00:00",
                            "Direction": "Negative",
                            "PercentChange": 13.533834586466165,
                            "FactName": "AcquisitionQuantity",
                            "FactQuantity": 8.0
                        }
                    ]
                }
            ]
        },
        {
            "id": "7941070bb17904f3ef4e19de9659110cb52e18ecfb637ad724e2da749445a860",
            "applicationId": "9NBLGGGZ5QDR",
            "insightDate": "2022-07-21T00:00:00",
            "dataType": "acquisition",
            "insightDetail": [
                {
                    "DimensionName": "AcquisitionType",
                    "DimensionValue": "Free",
                    "Date": "2022-07-21 00:00:00",
                    "FactName": "AcquisitionQuantity",
                    "SubDimensions": [
                        {
                            "DimensionName": "Market",
                            "DimensionValue": "AT",
                            "Date": "2022-07-21 00:00:00",
                            "Direction": "Positive",
                            "PercentChange": 0.0,
                            "FactName": "AcquisitionQuantity",
                            "FactQuantity": 17.0
                        }
                    ]
                },
                {
                    "DimensionName": "AcquisitionType",
                    "DimensionValue": "Free",
                    "Date": "2022-07-21 00:00:00",
                    "FactName": "AcquisitionQuantity",
                    "SubDimensions": [
                        {
                            "DimensionName": "Market",
                            "DimensionValue": "SE",
                            "Date": "2022-07-21 00:00:00",
                            "Direction": "Negative",
                            "PercentChange": 21.686746987951807,
                            "FactName": "AcquisitionQuantity",
                            "FactQuantity": 5.0
                        }
                    ]
                }
            ]
        },
        {
            "id": "55905f5458617b65669eb115cc28ebd7296841bd2ff3f8e2546ade1d5e93f68d",
            "applicationId": "9NBLGGGZ5QDR",
            "insightDate": "2022-07-13T00:00:00",
            "dataType": "acquisition",
            "insightDetail": [
                {
                    "DimensionName": "AcquisitionType",
                    "DimensionValue": "Free",
                    "Date": "2022-07-13 00:00:00",
                    "FactName": "AcquisitionQuantity",
                    "SubDimensions": [
                        {
                            "DimensionName": "Market",
                            "DimensionValue": "LK",
                            "Date": "2022-07-13 00:00:00",
                            "Direction": "Negative",
                            "PercentChange": 11.111111111111111,
                            "FactName": "AcquisitionQuantity",
                            "FactQuantity": 9.0
                        }
                    ]
                }
            ]
        },
        {
            "id": "9ce9317bf4d0f903de51a49d00a07cf4b4a8ac4457fd1e2886493bd38ceac0b7",
            "applicationId": "9NBLGGGZ5QDR",
            "insightDate": "2022-07-19T00:00:00",
            "dataType": "acquisition",
            "insightDetail": [
                {
                    "DimensionName": "Acquisition",
                    "DimensionValue": "Free",
                    "Date": "2022-07-19 00:00:00",
                    "Direction": "Negative",
                    "PercentChange": 12.188725230475788,
                    "FactName": "AcquisitionQuantity",
                    "FactQuantity": 2470,
                    "SubDimensions": []
                }
            ]
        }
    ],
    "TotalCount": 7
}