获取应用安装

在 Microsoft Store 分析 API 中使用此方法,以获取在给定日期范围和其他可选筛选器期间应用的 JSON 格式的聚合安装数据。 合作伙伴中心的 购置报告 中也提供了此信息。

先决条件

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

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

请求

请求语法

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

请求标头

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

请求参数

参数 类型 DESCRIPTION 必选
应用ID 字符串 您希望检索安装数据的应用在应用商店中的 ID 是的
开始日期 日期 要检索的安装数据的日期范围内的开始日期。 默认值为当前日期。
结束日期 日期 要检索的安装数据的日期范围中的结束日期。 默认值为当前日期。
顶部 整数 (int) 请求中要返回的数据行数。 如果未指定,则最大值和默认值为 10000。 如果查询中有更多行,响应正文将包含下一个链接,可用于请求下一页的数据。
跳过 整数 (int) 查询中要跳过的行数。 使用此参数可分页浏览大型数据集。 例如,top=10000 和 skip=0 检索前 10000 行数据,top=10000 和 skip=10000 检索接下来的 10000 行数据,依此等。
过滤器 字符串 一个或多个用于筛选响应中行的语句。 每个语句都包含响应正文中的字段名称和值,这些字段名称与 eqne 运算符相关联,语句可以使用 进行组合。 字符串值必须用 筛选器 参数中的单引号括起来。 可以从响应正文中指定以下字段:

  • 市场
  • 操作系统版本
  • 设备类型
  • 软件包版本
聚合级别 字符串 指定要检索聚合数据的时间范围。 可以是以下字符串之一:dayweekmonth。 如果未指定,默认值为 day
排序 字符串 对每个安装的结果数据值进行排序的语句。 语法为 orderby=field [order],field [order],...字段 参数可以是响应正文中的以下字段之一:

  • 应用程序名称
  • 日期
  • 设备类型
  • 市场
  • 操作系统版本
  • 软件包版本
  • 成功安装次数

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

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

按组分类 字符串 仅对指定字段应用数据聚合的语句。 可以从响应正文中指定以下字段:

  • 应用程序名称
  • 日期
  • 设备类型
  • 市场
  • 操作系统版本
  • 软件包版本

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

  • 日期
  • 应用程序 ID
  • 成功安装次数

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

 

请求示例

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

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

响应

响应体

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

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

价值 类型 DESCRIPTION
日期 字符串 安装数据日期范围内的第一个日期。 如果请求指定了某一天,此值就是该日期。 如果请求指定了一周、月或其他日期范围,则此值是该日期范围内的第一个日期。
应用ID 字符串 您正在检索其安装数据的应用的商店 ID。
应用程序名称 字符串 应用的显示名称。
设备类型 字符串 以下字符串之一,指定完成安装的设备的类型:

  • 个人电脑
  • 电话
  • Console-Xbox One
  • Console-Xbox 系列 X
  • 物联网
  • 全息
  • 未知
软件包版本 字符串 已安装的包的版本。
osVersion 字符串 以下字符串之一,指定安装所在的操作系统版本:

  • Windows Phone 7.5 版
  • Windows Phone 8作系统
  • Windows Phone 8.1 版
  • Windows Phone 10作系统
  • Windows 8作系统
  • Windows 8.1
  • Windows 10
  • Windows 11
  • 未知
市场 字符串 安装所在的市场的 ISO 3166 国家/地区代码。
成功安装计数 数字 指定聚合级别期间成功安装的次数。

请求和响应示例

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

示例请求

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

示例响应

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "successfulInstallCount": 100053
        }
    ],
    "TotalCount": 1
}

示例请求

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

示例响应

{
    "Value": [
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "AR",
            "osVersion": "Windows 10",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "AU",
            "osVersion": "Windows 10",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "BD",
            "osVersion": "Windows 10",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "BG",
            "osVersion": "Windows 11",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "BO",
            "osVersion": "Windows 10",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "BR",
            "osVersion": "Windows 10",
            "successfulInstallCount": 6
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "BR",
            "osVersion": "Windows 11",
            "successfulInstallCount": 3
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "CA",
            "osVersion": "Windows 11",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "CN",
            "osVersion": "Windows 11",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "MX",
            "osVersion": "Windows 10",
            "successfulInstallCount": 1
        }
    ],
    "TotalCount": 10
}
  • 安装报表
  • 通过 Microsoft 应用商店服务 获取分析数据