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

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

Необходимые компоненты

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

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

Запросить

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

Способ URI запроса
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings

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

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

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

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

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

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

No
Groupby строка Инструкция, которая применяет агрегирование данных только к указанным полям. Можно указать следующие поля:
  • date
  • applicationName
  • Рынке
  • osVersion
  • deviceType
  • isRevised

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

  • date
  • applicationId
  • fiveStars
  • fourStars
  • threeStars
  • twoStars
  • oneStar

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

No

 

Поля фильтра

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

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

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

Поля Description
на рынок Строка, содержащая код страны ISO 3166 рынка, на котором было оценено ваше приложение.
osVersion Одна из следующих строк:
  • Windows Телефон 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Windows Телефон 10
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Unknown
deviceType Одна из следующих строк:
  • ПК
  • Для телефонов
  • Console-Xbox One
  • Серия Xbox X консоли
  • Интернет вещей
  • Голографической
  • Unknown
isRevised Укажите значение 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>

Response

Текст ответа

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

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

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

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

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

В следующих фрагментах кода показан пример текста запроса и текста ответа 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
}