在 Microsoft Store 分析 API 中使用此方法,以获取给定日期范围和其他可选筛选器的 JSON 格式的评论数据。 此信息也可以在合作伙伴中心的 评审报告 中获得。
检索应用评审后,可以使用 获取评审回复信息的功能 和 Microsoft Store 评价 API 中的提交评审回复 方法,以编程方式对评审进行回应。
先决条件
若要使用此方法,首先需要执行以下操作:
- 完成 Microsoft Store 分析 API 的所有先决条件(如果尚未这样做)。
- 获取 Azure AD 访问令牌,以供在此方法的请求标头中使用。 获取访问令牌后,在它到期前,你有 60 分钟的使用时间。 令牌过期后,可以获取一个新令牌。
请求
请求语法
| 方法 | 请求 URI |
|---|---|
| 获取 | https://manage.devcenter.microsoft.com/v1.0/my/analytics/reviews |
请求标头
| 标题 | 类型 | DESCRIPTION |
|---|---|---|
| 授权 | 字符串 | 必填。 Azure AD 访问令牌,形式为Bearer<token>。 |
请求参数
| 参数 | 类型 | DESCRIPTION | 必选 |
|---|---|---|---|
| 应用ID | 字符串 | 要检索其评论数据的应用在应用商店中的 ID 为 。 | 是的 |
| 开始日期 | 日期 | 要检索的审阅数据日期范围的开始日期。 默认值为当前日期。 | 否 |
| 结束日期 | 日期 | 要检索的日期范围中审阅数据的结束日期。 默认值为当前日期。 | 否 |
| 顶部 | 整数 (int) | 请求中要返回的数据行数。 如果未指定,则最大值和默认值为 10000。 如果查询中有更多行,响应正文将包含下一个链接,可用于请求下一页的数据。 | 否 |
| 跳过 | 整数 (int) | 查询中要跳过的行数。 使用此参数可分页浏览大型数据集。 例如,top=10000 和 skip=0 检索前 10000 行数据,top=10000 和 skip=10000 检索接下来的 10000 行数据,依此等。 | 否 |
| 过滤器 | 字符串 | 一个或多个用于筛选响应中行的语句。 有关详细信息,请参阅下面的 筛选器字段 部分。 | 否 |
| 排序 | 字符串 | 对结果数据值进行排序的语句。 语法为 orderby=field [order],field [order],...。字段 参数可以是以下字符串之一:
顺序参数是可选的,可以是 asc 或 desc 来指定每个字段的升序或降序。 默认值为 asc。 下面是一个 orderby 字符串的示例:orderby=date,market |
否 |
筛选字段
请求的 筛选器 参数包含一个或多个语句,用于筛选响应中的行。 每个语句都包含一个字段和值,这些字段与 eq 或 ne 运算符相关联,某些字段还支持 包含、gt、lt、ge和 le 运算符。 语句可以使用 和 或 或组合。
下面是 筛选器 字符串的示例:filter=contains(reviewText,'great') 和 contains(reviewText,'ads') 和 deviceRAM lt 2048 和 market eq 'US'
有关每个字段及其支持的运算符的列表,请参阅下表。 字符串值必须用 筛选器 参数中的单引号括起来。
| 领域 | 支持的运算符 | DESCRIPTION |
|---|---|---|
| 市场 | eq、ne | 包含设备市场的 ISO 3166 国家/地区代码的字符串。 |
| osVersion | eq、ne | 以下字符串之一:
|
| 设备类型 | eq、ne | 以下字符串之一:
|
| 已修订 | eq、ne | 指定 真 来筛选已修订的评审;否则 假。 |
| 软件包版本 | eq、ne | 已评审的应用包的版本。 |
| 设备型号 | eq、ne | 应用被审核的设备类型。 |
| product系列 | eq、ne | 以下字符串之一:
|
| 设备内存 | eq, ne, gt, lt, ge, le | 物理 RAM(以 MB 为单位)。 |
| 设备屏幕分辨率 | eq、ne | 设备屏幕分辨率的格式为“宽度 x 高度”。 |
| 设备存储容量 | eq, ne, gt, lt, ge, le | 主存储磁盘的容量(以 GB 为单位)。 |
| 是否启用触摸 | eq、ne | 指定 true 来筛选支持触摸的设备,否则 false。 |
| reviewer 姓名 | eq、ne | 审阅者名称。 |
| 评级 | eq, ne, gt, lt, ge, le | 应用分级,以星为单位。 |
| 评论标题 | 等于(eq)、不等于(ne)、包含(contains) | 评论标题 |
| 评论文本 | 等于(eq)、不等于(ne)、包含(contains) | 审阅的文本内容。 |
| 有用计数 | eq、ne | 评价被标记为有用的次数。 |
| 不有帮助计数 | eq、ne | 评论被标记为没有帮助的次数。 |
| 响应日期 | eq、ne | 提交的响应日期。 |
| 响应文本 | 等于(eq)、不等于(ne)、包含(contains) | 响应的文本内容。 |
| id | eq、ne | 评审的 ID(这是 GUID)。 |
请求示例
以下示例演示了获取评审数据的多个请求。 将 applicationId 值替换为应用的应用商店 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>
响应
响应体
| 价值 | 类型 | DESCRIPTION |
|---|---|---|
| 价值 | 数组 | 包含评论数据的对象数组。 有关每个对象中的数据的详细信息,请参阅下面的 审查值 部分。 |
| @nextLink | 字符串 | 如果有其他数据页,此字符串包含可用于请求下一页数据的 URI。 例如,如果请求的 顶部 参数设置为 10000,但查询的评审数据超过 10000 行,则返回此值。 |
| 总计数 | 整数 (int) | 查询的数据结果中的行总数。 |
审核值
Value 数组中的元素包含以下值。
| 价值 | 类型 | DESCRIPTION |
|---|---|---|
| 日期 | 字符串 | 审阅数据的日期范围中的第一个日期。 如果请求指定了某一天,此值就是该日期。 如果请求指定了一周、月或其他日期范围,则此值是该日期范围内的第一个日期。 |
| 应用ID | 字符串 | 要为其检索评审数据的应用的应用商店 ID。 |
| 应用程序名称 | 字符串 | 应用的显示名称。 |
| 市场 | 字符串 | 提交评论的市场的 ISO 3166 国家/地区代码。 |
| osVersion | 字符串 | 提交评审的 OS 版本。 有关支持的字符串列表,请参阅上面的 筛选器字段 部分。 |
| 设备类型 | 字符串 | 提交评审的设备类型。 有关支持的字符串列表,请参阅上面的 筛选器字段 部分。 |
| 已修订 | 布尔型 | 值 true 指示审阅已修订;否则 false。 |
| 软件包版本 | 字符串 | 已评审的应用包的版本。 |
| 设备型号 | 字符串 | 应用被审核的设备类型。 |
| product系列 | 字符串 | 设备系列名称。 有关支持的字符串列表,请参阅上面的 筛选器字段 部分。 |
| 设备内存 | 数字 | 物理 RAM(以 MB 为单位)。 |
| 设备屏幕分辨率 | 字符串 | 设备屏幕分辨率的格式为“宽度 x 高度”。 |
| 设备存储容量 | 数字 | 主存储磁盘的容量(以 GB 为单位)。 |
| 是否启用触摸 | 布尔型 | true 的值表示已启用触摸,否则为 false。 |
| reviewer 姓名 | 字符串 | 审阅者名称。 |
| 评级 | 数字 | 应用分级,以星为单位。 |
| 评论标题 | 字符串 | 评论标题 |
| 评论文本 | 字符串 | 审阅的文本内容。 |
| 有用计数 | 数字 | 评价被标记为有用的次数。 |
| 不有帮助计数 | 数字 | 评论被标记为没有帮助的次数。 |
| 响应日期 | 字符串 | 提交的回复日期。 |
| 响应文本 | 字符串 | 响应的文本内容。 |
| id | 字符串 | 评审的 ID(这是 GUID)。 可以在 方法中使用此 ID 获取应用评审的响应信息,并在 方法中使用此 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 应用商店服务 获取分析数据
- 获取应用评论的响应信息
- 提交对应用评论的回复
- 获取应用安装量
- 获取插件
- 获取错误报告数据
- 获取应用分级