Получение отзывов о приложении

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

После получения отзывов вы можете использовать методы получения сведений об ответах на отзывы о приложении и отправки ответов на отзывы о приложении в API отзывов Microsoft Store, чтобы программно отвечать на отзывы.

Предварительные требования

Для использования этого метода сначала необходимо сделать следующее:

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

Запрос

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

Метод Универсальный код ресурса (URI) запроса
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/reviews

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

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

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

Параметр Тип Описание Обязательно
applicationId строка Код приложения в Магазине, для которого требуется получить данные проверки. Да
startDate Дата Начальная дата диапазона дат, для которого требуется получить данные об отзывах. По умолчанию используется текущая дата. Нет
endDate Дата Конечная дата диапазона дат, для которого требуется получить данные об отзывах. По умолчанию используется текущая дата. нет
top INT Количество строк данных, возвращаемых в запросе. Максимальное значение и значение по умолчанию (если параметр не указан) — 10 000. Если в запросе содержится больше строк, то тело ответа будет содержать ссылку «Далее», которую можно использовать для запроса следующей страницы данных Нет
skip INT Количество строк, пропускаемых в запросе. Используйте этот параметр для постраничного перемещения по большим наборам данных. Например, при top=10000 и skip=0 извлекаются первые 10 000 строк данных; при top=10000 и skip=10000 извлекаются следующие 10 000 строк данных и т. д. Нет
фильтр строка Одно или несколько выражений для фильтрации строк в ответе. Дополнительные сведения см. далее в разделе фильтрация полей Нет
orderby строка Выражение, которое определяет порядок полученных значений данных. Используется следующий синтаксис: orderby=field [order],field [order],..., где параметр field может принимать одно из следующих строковых значений:
  • date
  • osVersion
  • Рынке
  • deviceType
  • isRevised
  • packageVersion
  • deviceModel
  • productFamily,
  • deviceScreenResolution,
  • isTouchEnabled,
  • имя рецензента
  • reviewTitle,
  • reviewText
  • helpfulCount,
  • notHelpfulCount
  • responseDate
  • responseText
  • deviceRAM,
  • deviceStorageCapacity,
  • Рейтинг

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

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

Нет

Поля фильтра

Параметр filter запроса содержит один или несколько операторов, фильтрующих строки в ответе. Каждый оператор содержит поле и значение, которые связаны с операторами выражения eq или ne, и некоторые поля также поддерживают операторы выражения contains, gt, lt, ge и le. Операторы можно комбинировать с помощью and или or.

Пример строки filter: filter=contains(reviewText,'great') and contains(reviewText,'ads') and deviceRAM lt 2048 and market eq 'US'.

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

Поля Поддерживаемые операторы Описание
market eq, ne Строка, которая содержит код страны рынка устройства по стандарту ISO 3166
osVersion eq, ne Одна из следующих строк:
  • Windows Phone 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Windows Phone 10
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Unknown
deviceType eq, ne Одна из следующих строк:
  • PC
  • Номер телефона
  • Консоль Xbox One
  • Консоль Xbox Серии X
  • Интернет вещей
  • Holographic (голография),
  • Unknown
isRevised eq, ne Если нужно отфильтровать пересмотренные отзывы, укажите значение true, в противном случае — false
packageVersion eq, ne Версия пакета приложения, на которую оставлен отзыв
deviceModel eq, ne Тип устройства, на котором был оставлен отзыв на приложение
productFamily, eq, ne Одна из следующих строк:
  • PC
  • Планшет
  • Номер телефона
  • Носимые устройства
  • Сервер
  • Collaborative
  • Другое
deviceRAM, eq, ne, gt, lt, ge, le Физическое ОЗУ в МБ.
deviceScreenResolution, eq, ne Разрешение экрана устройства в формате "ширина x высота".
deviceStorageCapacity, eq, ne, gt, lt, ge, le Объем основного запоминающего устройства в ГБ.
isTouchEnabled, eq, ne Если нужно отфильтровать устройства с поддержкой сенсорного ввода, укажите значение true, в противном случае — false
reviewerName, eq, ne Имя автора отзыва.
рейтинг eq, ne, gt, lt, ge, le Оценка приложения в звездах.
reviewTitle, eq, ne, contains Заголовок отзыва.
reviewText, eq, ne, contains Текстовое содержимое отзыва.
helpfulCount, eq, ne Количество оценок отзыва как полезного.
notHelpfulCount eq, ne Количество оценок отзыва как бесполезного.
responseDate eq, ne Дата отправки ответа.
responseText eq, ne, contains Текстовое содержимое ответа.
идентификатор eq, ne ИД отзыва (это GUID).

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

Ниже приведено несколько примеров запросов для получения данных об отзывах. Замените значение applicationId кодом продукта в Магазине для вашего приложения.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/reviews?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/reviews?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=contains(reviewText,'great') and contains(reviewText,'ads') and deviceRAM lt 2048 and market eq 'US' HTTP/1.1
Authorization: Bearer <your access token>

Ответ

Текст ответа

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

 

Значения отзывов

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

Значение Тип Описание
Дата строка Первая дата в диапазоне дат, для которого требуется получить данные об отзывах. Если в запросе указан один день, это значение равно дате, соответствующей тому дню. Если запрос указывает неделю, месяц или другой диапазон дат, это значение равно первой дате в этом диапазоне дат.
applicationId строка Код продукта в Магазине для приложения, по которому запрашиваются данные об отзывах.
applicationName строка Отображаемое имя приложения.
market строка Код страны рынка, на котором был отправлен отзыв, по стандарту ISO 3166.
osVersion строка Версия ОС, в которой был отправлен отзыв. Список поддерживаемых строк см. выше в разделе Поля фильтра
deviceType строка Тип устройства, на котором был отправлен отзыв. Список поддерживаемых строк см. выше в разделе Поля фильтра
isRevised Логическое Значение true указывает, что отзыв был пересмотрен; в противном случае используется значение false
packageVersion строка Версия пакета приложения, на которую оставлен отзыв
deviceModel строка Тип устройства, на котором был оставлен отзыв на приложение
productFamily, строка Имя семейства устройств. Список поддерживаемых строк см. выше в разделе Поля фильтра
deviceRAM, number Физическое ОЗУ в МБ.
deviceScreenResolution, строка Разрешение экрана устройства в формате "ширина x высота".
deviceStorageCapacity, number Объем основного запоминающего устройства в ГБ.
isTouchEnabled, Логическое Значение true указывает, что сенсорный ввод включен; в противном случае используется значение false
reviewerName, строка Имя автора отзыва.
рейтинг number Оценка приложения в звездах.
reviewTitle, строка Заголовок отзыва.
reviewText, строка Текстовое содержимое отзыва.
helpfulCount, number Количество оценок отзыва как полезного.
notHelpfulCount number Количество оценок отзыва как бесполезного.
responseDate строка Дата отправки ответа.
responseText строка Текстовое содержимое ответа.
идентификатор строка ИД отзыва (это GUID). Вы можете использовать этот ИД в методах получения сведений об ответах на отзывы о приложении и отправки ответов на отзывы о приложении.

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

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/reviews?applicationId=9WZDNCRFJB4P&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>

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

{
    "Value": [
        {
            "date": "3/5/2021 12:48:33 PM",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "ES",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": false,
            "packageVersion": "2.5.2.34894",
            "reviewerName": "Jose Antonio",
            "rating": 5,
            "reviewTitle": "Contoso Demo",
            "reviewText": "Un juego fantastico",
            "helpfulCount": 3,
            "notHelpfulCount": 0,
            "id": "b5e27de9-2334-4849-d17d-4eae3e1e7aa9"
        },
        {
            "date": "1/6/2021 8:41:42 AM",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "TR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": false,
            "packageVersion": "2.5.2.34894",
            "reviewerName": "fef",
            "rating": 5,
            "helpfulCount": 0,
            "notHelpfulCount": 0,
            "id": "f5d2510a-9796-45ee-01e5-6d5cc4550b09"
        }
    ],
    "TotalCount": 2
}