获取应用分级

在 Microsoft Store 分析 API 中使用此方法,以获取给定日期范围和其他可选筛选器的 JSON 格式的聚合分级数据。 此信息也可以在合作伙伴中心的 评审报告 中获得。

先决条件

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

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

请求

请求语法

方法 请求 URI
获取 https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings

请求标头

标题 类型 DESCRIPTION
授权 字符串 必填。 Azure AD 访问令牌,形式为Bearer<token>。

请求参数

参数 类型 DESCRIPTION 必选
应用ID 字符串 要为其检索分级数据的应用的 应用商店 ID 是的
开始日期 日期 要检索的评级数据的日期范围内的开始日期。 默认值为当前日期。
结束日期 日期 要检索的评级数据的日期范围内的结束日期。 默认值为当前日期。
顶部 整数 (int) 请求中要返回的数据行数。 如果未指定,则最大值和默认值为 10000。 如果查询中有更多行,响应正文将包含下一个链接,可用于请求下一页的数据。
跳过 整数 (int) 查询中要跳过的行数。 使用此参数可分页浏览大型数据集。 例如,top=10000 和 skip=0 检索前 10000 行数据,top=10000 和 skip=10000 检索接下来的 10000 行数据,依此等。
过滤器 字符串 一个或多个用于筛选响应中行的语句。 有关详细信息,请参阅下面的 筛选器字段 部分。
聚合级别 字符串 指定要检索聚合数据的时间范围。 可以是以下字符串之一:dayweekmonth。 如果未指定,默认值为 day
排序 字符串 对每个分级的结果数据值进行排序的语句。 语法为 orderby=field [order],field [order],...字段 参数可以是以下字符串之一:
  • 日期
  • 操作系统版本
  • 市场
  • 设备类型
  • 已修订

顺序参数是可选的,可以是 ascdesc 来指定每个字段的升序或降序。 默认值为 asc

下面是一个 orderby 字符串的示例:orderby=date,market

按组分类 字符串 仅对指定字段应用数据聚合的语句。 可以指定以下字段:
  • 日期
  • applicationName
  • 市场
  • 操作系统版本
  • 设备类型
  • 已修订

返回的数据行将包含 groupby 参数中指定的字段,如下所示:

  • 日期
  • applicationId
  • 五星
  • 四星
  • 三星
  • 两星
  • 一星

groupby 参数可与 aggregationLevel 参数一起使用。 例如: &groupby=osVersion,market&aggregationLevel=week

 

筛选字段

请求的 筛选器 参数包含一个或多个语句,用于筛选响应中的行。 每个语句都包含一个字段和值,这些字段和值与 eqne 运算符相关联,可以使用 组合语句。

下面是 筛选器 字符串的示例:filter=market eq 'US' and deviceType eq 'phone' and isRevised eq true

有关支持字段的列表,请参阅下表。 字符串值必须用 筛选器 参数中的单引号括起来。

领域 DESCRIPTION
市场 一个字符串,其中包含应用的分级市场 ISO 3166 国家/地区代码。
osVersion 以下字符串之一:
  • Windows Phone 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Windows Phone 10
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • 未知
设备类型 以下字符串之一:
  • 个人电脑
  • 电话
  • Console-Xbox One
  • Console-Xbox 系列 X
  • IoT
  • 全息
  • 未知
已修订 指定 true 以筛选已修订的分级;否则 false

请求示例

以下示例演示了用于获取评分数据的多个请求。 将 applicationId 值替换为应用的应用商店 ID。

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings?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/ratings?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and deviceType eq 'phone' HTTP/1.1
Authorization: Bearer <your access token>

响应

响应体

价值 类型 DESCRIPTION
价值 数组 包含聚合分级数据的对象数组。 有关每个对象中的数据的详细信息,请参阅下面的 分级值 部分。
@nextLink 字符串 如果有其他数据页,此字符串包含可用于请求下一页数据的 URI。 例如,如果请求的 顶端参数 设置为 10000,但查询的评级数据超过 10000 行,则返回此值。
总计数 整数 (int) 查询的数据结果中的行总数。

分级值

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

价值 类型 DESCRIPTION
日期 字符串 分级数据日期范围内的第一个日期。 如果请求指定了某一天,此值就是该日期。 如果请求指定了一周、月或其他日期范围,则此值是该日期范围内的第一个日期。
应用ID 字符串 要为其检索评级数据的应用的应用商店 ID。
应用程序名称 字符串 应用的显示名称。
市场 字符串 提交评级的市场的 ISO 3166 国家/地区代码。
osVersion 字符串 提交评级的操作系统版本。 有关支持的字符串列表,请参阅上面的 筛选器字段 部分。
设备类型 字符串 提交分级的设备的类型。 有关支持的字符串列表,请参阅上面的 筛选器字段 部分。
已修订 布尔型 true 指示评级已修订;否则 false
oneStar 数字 单星评级的数量。
twoStars 数字 双星评级的数量。
threeStars 数字 三星级评分的数量。
fourStars 数字 四星评级的数量。
fiveStars 数字 五星评分的数量。

请求和响应示例

以下代码片段演示了这些请求的一些示例请求和 JSON 响应正文。

示例请求

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>

示例响应


{
    "Value": [
        {
            "date": "2012-09-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "oneStar": 1,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 1,
            "fiveStars": 3
        },
        {
            "date": "2012-09-02",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "oneStar": 3,
            "twoStars": 0,
            "threeStars": 1,
            "fourStars": 2,
            "fiveStars": 17
        },
        {
            "date": "2012-09-03",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "oneStar": 1,
            "twoStars": 1,
            "threeStars": 1,
            "fourStars": 5,
            "fiveStars": 17
        },
  ],
    "TotalCount": 3
}

示例请求

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings?applicationId=9NBLGGGZ5QDR&startDate=06/19/2022&endDate=07/20/2022&top=10&skip=0&groupby=date,applicationName,market,osVersion,deviceType,isRevised
HTTP/1.1
Authorization: Bearer <your access token>

示例响应

{
    "Value": [
        {
            "date": "2022-06-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "CL",
            "osVersion": "Windows 11",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-06-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "TR",
            "osVersion": "Windows 11",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-06-29",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "FR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 1,
            "fiveStars": 0
        },
        {
            "date": "2022-07-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "BR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-07-04",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "ES",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-07-06",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "ES",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-07-07",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "AE",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "true",
            "oneStar": 1,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 0
        },
        {
            "date": "2022-07-10",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "BR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "true",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-07-13",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "EG",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-07-14",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "BR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "true",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 1,
            "fiveStars": 0
        }
    ],
    "TotalCount": 10
}