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

Используйте этот метод в API аналитики для Microsoft Store для получения рецензий в формате JSON в заданном диапазоне дат или с учетом других дополнительных фильтров.Use this method in the Microsoft Store analytics API to get review data in JSON format for a given date range and other optional filters. Эти сведения также доступны в отчете о проверках в центре партнеров.This information is also available in the Reviews report in Partner Center.

После получения отзывов вы можете использовать методы получения сведений об ответах на отзывы о приложении и отправки ответов на отзывы о приложении в API отзывов Microsoft Store, чтобы программно отвечать на отзывы.After you retrieve reviews, you can use the get response info for app reviews and submit responses to app reviews methods in the Microsoft Store reviews API to programmatically respond to reviews.

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

Для использования этого метода сначала необходимо сделать следующее:To use this method, you need to first do the following:

  • Если вы еще не сделали этого, выполните все необходимые условия для API аналитики для Microsoft Store.If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
  • Получите маркер доступа Azure AD, который будет использоваться в заголовке запроса этого метода.Obtain an Azure AD access token to use in the request header for this method. После получения маркера доступа у вас будет 60 минут, чтобы использовать его до истечения срока действия.After you obtain an access token, you have 60 minutes to use it before it expires. После истечения срока действия маркера можно получить новый маркер.After the token expires, you can obtain a new one.

ЗапросRequest

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

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

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

ЗаголовокHeader ТипType ОписаниеDescription
АвторизацияAuthorization строкаstring Обязательный элемент.Required. Маркер доступа Azure AD в формате Bearer <token>.The Azure AD access token in the form Bearer <token>.

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

ПараметрParameter ТипType ОписаниеDescription Обязательное значениеRequired
applicationIdapplicationId строкаstring Идентификатор хранилища приложения, для которого требуется получить данные проверки.The Store ID of the app for which you want to retrieve review data. ДаYes
startDatestartDate Датаdate Начальная дата диапазона дат, для которого требуется получить данные об отзывах.The start date in the date range of review data to retrieve. По умолчанию используется текущая дата.The default is the current date. НетNo
endDateendDate Датаdate Конечная дата диапазона дат, для которого требуется получить данные об отзывах.The end date in the date range of review data to retrieve. По умолчанию используется текущая дата.The default is the current date. нетNo
toptop INTint Количество строк данных, возвращаемых в запросе.The number of rows of data to return in the request. Максимальное значение и значение по умолчанию (если параметр не указан) — 10 000.The maximum value and the default value if not specified is 10000. Если в запросе содержится больше строк, то тело ответа будет содержать ссылку «Далее», которую можно использовать для запроса следующей страницы данныхIf there are more rows in the query, the response body includes a next link that you can use to request the next page of data. НетNo
skipskip INTint Количество строк, пропускаемых в запросе.The number of rows to skip in the query. Используйте этот параметр для постраничного перемещения по большим наборам данных.Use this parameter to page through large data sets. Например, при top=10000 и skip=0 извлекаются первые 10 000 строк данных; при top=10000 и skip=10000 извлекаются следующие 10 000 строк данных и т. д.For example, top=10000 and skip=0 retrieves the first 10000 rows of data, top=10000 and skip=10000 retrieves the next 10000 rows of data, and so on. НетNo
фильтрfilter строкаstring Одно или несколько выражений для фильтрации строк в ответе.One or more statements that filter the rows in the response. Дополнительные сведения см. далее в разделе фильтрация полейFor more information, see the filter fields section below. НетNo
orderbyorderby строкаstring Выражение, которое определяет порядок полученных значений данных.A statement that orders the result data values. Используется следующий синтаксис: orderby=field [order],field [order],..., где параметр field может принимать одно из следующих строковых значений:The syntax is orderby=field [order],field [order],.... The field parameter can be one of the following strings:
  • datedate
  • osVersionosVersion
  • звонкmarket
  • Типа устройстваdeviceType
  • isRevisedisRevised
  • packageVersionpackageVersion
  • deviceModeldeviceModel
  • productFamily,productFamily
  • deviceScreenResolution,deviceScreenResolution
  • isTouchEnabled,isTouchEnabled
  • reviewerName,reviewerName
  • reviewTitle,reviewTitle
  • ревиевтекстreviewText
  • helpfulCount,helpfulCount
  • notHelpfulCountnotHelpfulCount
  • responseDateresponseDate
  • responseTextresponseText
  • deviceRAM,deviceRAM
  • deviceStorageCapacity,deviceStorageCapacity
  • звездочкrating

Параметр order является необязательным и может принимать значения asc или desc, которые указывают, соответственно, порядок сортировки по возрастанию или по убыванию для каждого поля.The order parameter is optional, and can be asc or desc to specify ascending or descending order for each field. Значение по умолчанию — ASC.The default is asc.

Ниже приведен пример строки OrderBy : OrderBy = Дата, рыночнаяHere is an example orderby string: orderby=date,market

НетNo

Поля фильтраFilter fields

Параметр filter запроса содержит один или несколько операторов, фильтрующих строки в ответе.The filter parameter of the request contains one or more statements that filter the rows in the response. Каждый оператор содержит поле и значение, которые связаны с операторами выражения eq или ne, и некоторые поля также поддерживают операторы выражения contains, gt, lt, ge и le.Each statement contains a field and value that are associated with the eq or ne operators, and some fields also support the contains, gt, lt, ge, and le operators. Операторы можно комбинировать с помощью and или or.Statements can be combined using and or or.

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

Список поддерживаемых полей и операторов для каждого поля см. в следующей таблице.For a list of the supported fields and support operators for each field, see the following table. В параметре filter строковые значения должны быть заключены в одиночные кавычки.String values must be surrounded by single quotes in the filter parameter.

ПоляFields Поддерживаемые операторыSupported operators ОписаниеDescription
marketmarket eq, neeq, ne Строка, которая содержит код страны рынка устройства по стандарту ISO 3166A string that contains the ISO 3166 country code of the device market.
osVersionosVersion eq, neeq, ne Одна из следующих строк:One of the following strings:
  • Windows Phone 7.5Windows Phone 7.5
  • Windows Phone 8Windows Phone 8
  • Windows Phone 8.1Windows Phone 8.1
  • Windows Phone 10Windows Phone 10
  • Windows 8Windows 8
  • Windows 8.1Windows 8.1
  • Windows 10Windows 10
  • UnknownUnknown
deviceTypedeviceType eq, neeq, ne Одна из следующих строк:One of the following strings:
  • ACPIPC
  • ФаксPhone
  • Консоль — Xbox OneConsole-Xbox One
  • Консоль — серия Xbox XConsole-Xbox Series X
  • Интернет вещейIoT
  • Holographic (голография),Holographic
  • UnknownUnknown
isRevisedisRevised eq, neeq, ne Если нужно отфильтровать пересмотренные отзывы, укажите значение true, в противном случае — falseSpecify true to filter for reviews that have been revised; otherwise false.
packageVersionpackageVersion eq, neeq, ne Версия пакета приложения, на которую оставлен отзывThe version of the app package that was reviewed.
deviceModeldeviceModel eq, neeq, ne Тип устройства, на котором был оставлен отзыв на приложениеThe type of device on which the app was reviewed.
productFamily,productFamily eq, neeq, ne Одна из следующих строк:One of the following strings:
  • ACPIPC
  • ПланшетTablet
  • ФаксPhone
  • Носимые устройстваWearable
  • ServerServer
  • CollaborativeCollaborative
  • ДругоеOther
deviceRAM,deviceRAM eq, ne, gt, lt, ge, leeq, ne, gt, lt, ge, le Физическое ОЗУ в МБ.The physical RAM, in MB.
deviceScreenResolution,deviceScreenResolution eq, neeq, ne Разрешение экрана устройства в формате "ширина x высота".The device screen resolution in the format "width x height".
deviceStorageCapacity,deviceStorageCapacity eq, ne, gt, lt, ge, leeq, ne, gt, lt, ge, le Объем основного запоминающего устройства в ГБ.The capacity of the primary storage disk, in GB.
isTouchEnabled,isTouchEnabled eq, neeq, ne Если нужно отфильтровать устройства с поддержкой сенсорного ввода, укажите значение true, в противном случае — falseSpecify true to filter for touch-enabled devices; otherwise false.
reviewerName,reviewerName eq, neeq, ne Имя автора отзыва.The reviewer name.
рейтингrating eq, ne, gt, lt, ge, leeq, ne, gt, lt, ge, le Оценка приложения в звездах.The app rating, in stars.
reviewTitle,reviewTitle eq, ne, containseq, ne, contains Заголовок отзыва.The title of the review.
reviewText,reviewText eq, ne, containseq, ne, contains Текстовое содержимое отзыва.The text contents of the review.
helpfulCount,helpfulCount eq, neeq, ne Количество оценок отзыва как полезного.The number of times the review was marked helpful.
notHelpfulCountnotHelpfulCount eq, neeq, ne Количество оценок отзыва как бесполезного.The number of times the review was marked not helpful.
responseDateresponseDate eq, neeq, ne Дата отправки ответа.The date that the response was submitted.
responseTextresponseText eq, ne, containseq, ne, contains Текстовое содержимое ответа.The text contents of the response.
идентификаторid eq, neeq, ne ИД отзыва (это GUID).The ID of the review (this is a GUID).

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

Ниже приведено несколько примеров запросов для получения данных об отзывах.The following examples demonstrate several requests for getting review data. Замените значение applicationId кодом продукта в Магазине для вашего приложения.Replace the applicationId value with the Store ID for your app.

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>

ОтветResponse

Текст ответаResponse body

ЗначениеValue ТипType ОписаниеDescription
ЗначениеValue arrayarray Массив объектов, содержащий информацию об отзывах.An array of objects that contain review data. Дополнительные сведения о данных в каждом объекте см. далее в разделе Значения отзывов.For more information about the data in each object, see the review values section below.
@nextLink строкаstring При наличии дополнительных страниц данных эта строка содержит универсальный код ресурса (URI), который можно использовать для запроса следующей страницы данных.If there are additional pages of data, this string contains a URI that you can use to request the next page of data. Например, это значение возвращается в том случае, если параметр top запроса имеет значение 10 000, но для данного запроса имеется больше 10 000 строк с информацией об отзывах.For example, this value is returned if the top parameter of the request is set to 10000 but there are more than 10000 rows of reviews data for the query.
TotalCountTotalCount INTint Общее количество строк в результирующих данных для запроса.The total number of rows in the data result for the query.

 

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

Элементы в массиве Value содержат следующие значения.Elements in the Value array contain the following values.

ЗначениеValue ТипType ОписаниеDescription
Датаdate строкаstring Первая дата в диапазоне дат, для которого требуется получить данные об отзывах.The first date in the date range for the review data. Если в запросе указан один день, это значение равно дате, соответствующей тому дню.If the request specified a single day, this value is that date. Если запрос указывает неделю, месяц или другой диапазон дат, это значение равно первой дате в этом диапазоне дат.If the request specified a week, month, or other date range, this value is the first date in that date range.
applicationIdapplicationId строкаstring Код продукта в Магазине для приложения, по которому запрашиваются данные об отзывах.The Store ID of the app for which you are retrieving review data.
applicationNameapplicationName строкаstring Отображаемое имя приложения.The display name of the app.
marketmarket строкаstring Код страны рынка, на котором был отправлен отзыв, по стандарту ISO 3166.The ISO 3166 country code of the market where the review was submitted.
osVersionosVersion строкаstring Версия ОС, в которой был отправлен отзыв.The OS version on which the review was submitted. Список поддерживаемых строк см. выше в разделе Поля фильтраFor a list of the supported strings, see the filter fields section above.
deviceTypedeviceType строкаstring Тип устройства, на котором был отправлен отзыв.The type of device on which the review was submitted. Список поддерживаемых строк см. выше в разделе Поля фильтраFor a list of the supported strings, see the filter fields section above.
isRevisedisRevised ЛогическийBoolean Значение true указывает, что отзыв был пересмотрен; в противном случае используется значение falseThe value true indicates that the review was revised; otherwise false.
packageVersionpackageVersion строкаstring Версия пакета приложения, на которую оставлен отзывThe version of the app package that was reviewed.
deviceModeldeviceModel строкаstring Тип устройства, на котором был оставлен отзыв на приложениеThe type of device on which the app was reviewed.
productFamily,productFamily строкаstring Имя семейства устройств.The device family name. Список поддерживаемых строк см. выше в разделе Поля фильтраFor a list of the supported strings, see the filter fields section above.
deviceRAM,deviceRAM numbernumber Физическое ОЗУ в МБ.The physical RAM, in MB.
deviceScreenResolution,deviceScreenResolution строкаstring Разрешение экрана устройства в формате "Ширина x Высота".The device screen resolution in the format "width x height".
deviceStorageCapacity,deviceStorageCapacity numbernumber Объем основного запоминающего устройства в ГБ.The capacity of the primary storage disk, in GB.
isTouchEnabled,isTouchEnabled ЛогическийBoolean Значение true указывает, что сенсорный ввод включен; в противном случае используется значение falseThe value true indicates that touch is enabled; otherwise false.
reviewerName,reviewerName строкаstring Имя автора отзыва.The reviewer name.
рейтингrating numbernumber Оценка приложения в звездах.The app rating, in stars.
reviewTitle,reviewTitle строкаstring Заголовок отзыва.The title of the review.
reviewText,reviewText строкаstring Текстовое содержимое отзыва.The text contents of the review.
helpfulCount,helpfulCount numbernumber Количество оценок отзыва как полезного.The number of times the review was marked helpful.
notHelpfulCountnotHelpfulCount numbernumber Количество оценок отзыва как бесполезного.The number of times the review was marked not helpful.
responseDateresponseDate строкаstring Дата отправки ответа.The date a response was submitted.
responseTextresponseText строкаstring Текстовое содержимое ответа.The text contents of the response.
идентификаторid строкаstring ИД отзыва (это GUID).The ID of the review (this is a GUID). Вы можете использовать этот ИД в методах получения сведений об ответах на отзывы о приложении и отправки ответов на отзывы о приложении.You can use this ID in the get response info for app reviews and submit responses to app reviews methods.

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

В следующем примере демонстрируется пример тела ответа JSON на данный запрос.The following example demonstrates an example JSON response body for this request.

{
  "Value": [
    {
      "date": "2015-07-29",
      "applicationId": "9NBLGGGZ5QDR",
      "applicationName": "Contoso demo",
      "market": "US",
      "osVersion": "10.0.10240.16410",
      "deviceType": "PC",
      "isRevised": true,
      "packageVersion": "",
      "deviceModel": "Microsoft Corporation-Virtual Machine",
      "productFamily": "PC",
      "deviceRAM": -1,
      "deviceScreenResolution": "1024 x 768",
      "deviceStorageCapacity": 51200,
      "isTouchEnabled": false,
      "reviewerName": "ALeksandra",
      "rating": 5,
      "reviewTitle": "Love it",
      "reviewText": "Great app for demos and great dev response.",
      "helpfulCount": 0,
      "notHelpfulCount": 0,
      "responseDate": "2015-08-07T01:50:22.9874488Z",
      "responseText": "1",
      "id": "6be543ff-1c9c-4534-aced-af8b4fbe0316"
    }
  ],
  "@nextLink": null,
  "TotalCount": 1
}