获取应用评价
在Microsoft存储分析 API 中使用此方法,以获取给定日期范围和其他可选筛选器的 JSON 格式的评审数据。 还可以在合作伙伴中心的评价报告中获取此信息。
检索评审后,可以使用 应用评审 的获取响应信息,并将 响应提交到 Microsoft 应用商店评价 API 中的应用评审 方法,以编程方式响应评论。
先决条件
若要使用此方法,首先需要执行以下操作:
- 完成 Microsoft Store 分析 API 的所有先决条件(如果尚未这样做)。
- 获取 Azure AD 访问令牌,以供在此方法的请求标头中使用。 获取访问令牌后,在它到期前,你有 60 分钟的使用时间。 该令牌到期后,可以获取新的令牌。
请求
请求语法
方法 | 请求 URI |
---|---|
GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/reviews |
请求头
标头 | 类型 | 说明 |
---|---|---|
授权 | 字符串 | 必需。 Azure AD 访问令牌的格式为 Bearertoken<>。 |
请求参数
参数 | 类型 | 描述 | 必需 |
---|---|---|---|
applicationId | string | 要检索其评论数据的应用的 Store ID。 | 是 |
startDate | date | 要检索的评论数据日期范围中的开始日期。 默认是当前日期。 | 否 |
endDate | date | 要检索的评论数据日期范围中的结束日期。 默认是当前日期。 | 否 |
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 参数可以是以下字符串之一:
order 参数是可选的,可以是 asc 或 desc,用于指定每个字段的升序或降序排列。 默认值为 asc。 下面是一个 orderby 字符串的示例:orderby=date,market |
否 |
筛选器字段
请求中的 filter 参数包含一条或多条用来在响应中筛选行的语句。 每个语句都包含一个与 eq 或 ne 运算符关联的字段和值,某些字段还支持 contains、lt、ge 和 le 运算符。 可以使用 或 或或 组合语句。
下面是一个示例筛选器字符串:filter=contains(reviewText,'great')和 contains(reviewText,'ads')和 deviceRAM lt 2048 和 market eq 'US'
有关每个字段支持的字段和支持运算符的列表,请参阅下表。 filter 参数中的字符串值必须使用单引号引起来。
字段 | 支持的运算符 | 说明 |
---|---|---|
market | eq、ne | 包含设备市场的 ISO 3166 国家/地区代码的字符串。 |
osVersion | eq、ne | 以下字符串之一:
|
deviceType | eq、ne | 以下字符串之一:
|
isRevised | eq、ne | 指定 true 以筛选已修订的评审;否则 为 false。 |
packageVersion | eq、ne | 已评审的应用包的版本。 |
deviceModel | eq、ne | 查看应用的设备类型。 |
productFamily | eq、ne | 以下字符串之一:
|
deviceRAM | eq、ne、gt、lt、ge、le | 物理 RAM(以 MB 为单位)。 |
deviceScreenResolution | eq、ne | 采用“width x height”格式的设备屏幕分辨率。 |
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 | string | 要为其检索评审数据的应用的应用商店 ID。 |
applicationName | string | 应用的显示名称。 |
market | string | 提交的市场的 ISO 3166 国家/地区代码。 |
osVersion | string | 提交评审的 OS 版本。 有关支持的字符串列表,请参阅上述筛选器字段部分。 |
deviceType | string | 提交评审的设备类型。 有关支持的字符串列表,请参阅上述筛选器字段部分。 |
isRevised | 布尔 | 值为 true 表示修订了评审;否则 为 false。 |
packageVersion | string | 已评审的应用包的版本。 |
deviceModel | string | 查看应用的设备类型。 |
productFamily | string | 设备系列名称。 有关支持的字符串列表,请参阅上述筛选器字段部分。 |
deviceRAM | 数字 | 物理 RAM(以 MB 为单位)。 |
deviceScreenResolution | string | 采用“width x height”格式的设备屏幕分辨率。 |
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
}