获取应用评价

使用 Microsoft Store 分析 API 中的此方法，可获取给定日期范围和其他可选筛选器的评价数据（格式为 JSON）。 还可以在合作伙伴中心的评价报告中获取此信息。

在检索评价后，可使用 Microsoft Store 评价 API 中的获取应用评价的回复信息和提交对应用评价的回复方法以可编程方式回复评价。

必备条件

若要使用此方法，首先需要执行以下操作：

• 完成 Microsoft Store 分析 API 的所有先决条件（如果尚未这样做）。
• 获取 Azure AD 访问令牌，以供在此方法的请求标头中使用。 获取访问令牌后，在它到期前，你有 60 分钟的使用时间。 该令牌到期后，可以获取新的令牌。

请求

请求语法

方法	请求 URI
GET	https://manage.devcenter.microsoft.com/v1.0/my/analytics/reviews

请求头

标头	类型	说明
授权	字符串	必需。 Azure AD 访问令牌的格式为 Bearertoken<>。

请求参数

参数	类型	说明	必需
applicationId	字符串	要检索评价数据的应用的 Store ID。	是
startDate	日期	要检索的评价数据日期范围中的开始日期。 默认值为当前日期。	否
endDate	日期	要检索的评价数据日期范围中的结束日期。 默认值为当前日期。	否
top	int	要在请求中返回的数据行数。 如果未指定，最大值和默认值为 10000。 当查询中存在多行数据时，响应正文中包含的下一个链接可用于请求下一页数据。	否
skip	int	要在查询中跳过的行数。 使用此参数可以浏览较大的数据集。 例如，top=10000 和 skip=0，将检索前 10000 行数据；top=10000 和 skip=10000，将检索之后的 10000 行数据，依此类推。	否
filter	string	在响应中筛选行的一条或多条语句。 有关详细信息，请参阅下面的筛选器字段部分。	否
orderby	string	对结果数据值进行排序的语句。 语法为 orderby=field [order],field [order],...，其中 field 参数可以是以下字符串之一： date osVersion market deviceType isRevised packageVersion deviceModel productFamily deviceScreenResolution isTouchEnabled reviewerName reviewTitle reviewText helpfulCount notHelpfulCount responseDate responseText deviceRAM deviceStorageCapacity rating 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 电话 Console-Xbox One Console-Xbox 系列 X IoT Holographic Unknown
isRevised	eq、ne	指定 true 可筛选已修改的评价，否则指定 false。
packageVersion	eq、ne	已评价的应用程序包版本。
deviceModel	eq、ne	应用已评价的设备的类型。
productFamily	eq、ne	以下字符串之一： PC 平板电脑 电话 可穿戴设备 Server Collaborative 其他
deviceRAM	eq、ne、gt、lt、ge、le	物理 RAM（以 MB 为单位）。
deviceScreenResolution	eq、ne	设备屏幕分辨率采用“宽度 x 高度”格式。
deviceStorageCapacity	eq、ne、gt、lt、ge、le	主存储器磁盘容量（以 GB 为单位）。
isTouchEnabled	eq、ne	指定 true 可筛选支持触摸的设备，否则指定 false。
reviewerName	eq、ne	评价者名称。
rating	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	回复的文本内容。
id	eq、ne	评价的 ID（这是一个 GUID）。

请求示例

以下示例演示用于获取评价数据的多个请求。 将 applicationId 值替换为你的应用的 Store ID。

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>

响应

响应正文

值	类型	说明
Value	array	包含评价数据的对象数组。 有关每个对象中的数据的详细信息，请参阅以下评价值部分。
@nextLink	string	如果存在其他数据页，则此字符串包含一个你可用来请求下一页数据的 URI。 例如，当请求的 top 参数设置为 10000，但查询的评价数据超过 10000 行时，就会返回此值。
TotalCount	int	查询的数据结果中的行总数。

 

评价值

Value 数组中的元素包含以下值。

Value	类型	说明
date	string	评价数据的日期范围内的第一个日期。 如果请求指定了某一天，此值就是该日期。 如果请求指定了一周、月或其他日期范围，此值是该日期范围内的第一个日期。
applicationId	字符串	要检索评价数据的应用的应用商店 ID。
applicationName	string	应用的显示名称。
market	string	评价已提交的市场的 ISO 3166 国家/地区代码。
osVersion	string	评价已提交的操作系统版本。 有关支持的字符串列表，请参阅上述筛选器字段部分。
deviceType	string	评价已提交的设备的类型。 有关支持的字符串列表，请参阅上述筛选器字段部分。
isRevised	布尔	值为 true 表示评价已修改；否则为 false。
packageVersion	string	已评价的应用程序包版本。
deviceModel	string	应用已评价的设备的类型。
productFamily	string	设备系列名称。 有关支持的字符串列表，请参阅上述筛选器字段部分。
deviceRAM	数值	物理 RAM（以 MB 为单位）。
deviceScreenResolution	string	设备屏幕分辨率采用“宽度 x 高度”格式。
deviceStorageCapacity	数值	主存储器磁盘容量（以 GB 为单位）。
isTouchEnabled	布尔	值为 true 表示触摸受支持；否则为 false。
reviewerName	string	评价者名称。
rating	数值	应用评分（以星级为单位）。
reviewTitle	string	评价的标题。
reviewText	string	评价的文本内容。
helpfulCount	数值	评价标记为有用的次数。
notHelpfulCount	数值	评价标记为无用的次数。
responseDate	string	回复的提交时间。
responseText	string	回复的文本内容。
id	string	评价的 ID（这是一个 GUID）。 你可以在获取应用评价的回复信息和提交对应用评价的回复方法中使用此 ID。

请求和响应示例

以下代码片段演示了这些请求的一些示例请求和 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
}

相关主题

• 评价报告
• 使用 Microsoft Store 服务访问分析数据
• 获取应用评价的回复信息
• 提交对应用评价的回复
• 获取应用购置
• 获取加载项购置
• 获取错误报告数据
• 获取应用评分