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


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

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

Предпосылки

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

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

Просьба

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

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

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

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

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

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

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

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

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

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

  • дата
  • applicationId
  • fiveStars
  • fourStars
  • threeStars
  • twoStars
  • oneStar

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

нет

 

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

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

Ниже приведен пример строки фильтра : filter=market eq 'US' и deviceType eq 'phone' и isRevised eq true

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

Поля Описание
рынок Строка, содержащая код страны 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 One
  • Console-Xbox серии X
  • Интернет вещей
  • Голографический
  • Неизвестный
пересмотрено Укажите значение true , чтобы отфильтровать оценки, которые были изменены; в противном случае значение false.

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings?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/ratings?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and deviceType eq 'phone' HTTP/1.1
Authorization: Bearer <your access token>

Ответ

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

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

Значения оценки

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

Ценность Тип Описание
дата струна Первая дата в диапазоне дат для данных оценок. Если запрос указал один день, это значение равно дате. Если запрос указал неделю, месяц или другой диапазон дат, это значение является первой датой в этом диапазоне дат.
applicationId струна Идентификатор магазина приложения, для которого извлекаются данные о рейтингах.
название приложения струна Отображаемое имя приложения.
рынок струна Код страны ISO 3166 для рынка, куда был подан рейтинг.
Версия ОС струна Версия ОС, на которую была отправлена оценка. Список поддерживаемых строк см. в разделе поля фильтра выше.
тип устройства струна Тип устройства, на котором была отправлена оценка. Список поддерживаемых строк см. в разделе поля фильтра выше.
пересмотрено Булев Значение true указывает, что оценка была изменена; в противном случае значение false.
oneStar число/номер Число однозвездочных рейтингов.
twoStars число/номер Количество двухзвездочных рейтингов.
threeStars число/номер Количество трехзвездочных рейтингов.
fourStars число/номер Количество четырехзвездочных рейтингов.
fiveStars число/номер Число пятизвездочных рейтингов.

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

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

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

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

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


{
    "Value": [
        {
            "date": "2012-09-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "oneStar": 1,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 1,
            "fiveStars": 3
        },
        {
            "date": "2012-09-02",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "oneStar": 3,
            "twoStars": 0,
            "threeStars": 1,
            "fourStars": 2,
            "fiveStars": 17
        },
        {
            "date": "2012-09-03",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "oneStar": 1,
            "twoStars": 1,
            "threeStars": 1,
            "fourStars": 5,
            "fiveStars": 17
        },
  ],
    "TotalCount": 3
}

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings?applicationId=9NBLGGGZ5QDR&startDate=06/19/2022&endDate=07/20/2022&top=10&skip=0&groupby=date,applicationName,market,osVersion,deviceType,isRevised
HTTP/1.1
Authorization: Bearer <your access token>

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

{
    "Value": [
        {
            "date": "2022-06-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "CL",
            "osVersion": "Windows 11",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-06-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "TR",
            "osVersion": "Windows 11",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-06-29",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "FR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 1,
            "fiveStars": 0
        },
        {
            "date": "2022-07-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "BR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-07-04",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "ES",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-07-06",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "ES",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-07-07",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "AE",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "true",
            "oneStar": 1,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 0
        },
        {
            "date": "2022-07-10",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "BR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "true",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-07-13",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "EG",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-07-14",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "BR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "true",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 1,
            "fiveStars": 0
        }
    ],
    "TotalCount": 10
}