获取订阅加载项购置

在 Microsoft Store 分析 API 中使用此方法,在指定日期范围内以及根据其他可选筛选条件,获取应用加载项订阅的聚合获取数据。

先决条件

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

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

请求

请求语法

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

请求标头

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

请求参数

参数 类型 DESCRIPTION 必选
应用ID 字符串 要为其检索订阅加载项购置数据的应用的 Store ID 是的
订阅产品 ID 字符串 要为其检索购置数据的订阅加载项 应用商店 ID。 如果未指定此值,此方法将返回指定应用的所有订阅加载项的购置数据。
开始日期 日期 要检索的订阅附加功能获取数据的日期范围的开始日期。 默认值为当前日期。
结束日期 日期 要检索的订阅加载项购置数据的日期范围内的结束日期。 默认值为当前日期。
顶部 整数 (int) 请求中要返回的数据行数。 如果未指定,则最大值和默认值为 100。 如果查询中有更多行,响应正文将包含下一个链接,可用于请求下一页的数据。
跳过 整数 (int) 查询中要跳过的行数。 使用此参数可分页浏览大型数据集。 例如,top=100 和 skip=0 检索前 100 行数据,top=100 和 skip=100 检索接下来的 100 行数据,依此等。
过滤器 字符串 用于筛选响应正文的一个或多个语句。 每个语句都可以使用eqne运算符,并且可以使用andor来组合语句。 可以在筛选器语句中指定以下字符串(这些字符串对应于 响应正文中的值):
  • 日期
  • subscriptionProductName 订阅产品名称
  • 应用程序名称
  • skuId 的
  • 市场
  • 设备类型

下面是一个 示例筛选器 参数: filter=date eq '2017-07-08'

聚合级别 字符串 指定要检索聚合数据的时间范围。 可以是下列字符串之一: dayweekmonth。 如果未指定,则默认值为 day
排序 字符串 一个用于对每个订阅加载项获取结果数据值进行排序的语句。 语法为 orderby=field [order],field [order],...。“field”参数可以是以下字符串之一:
  • 日期
  • subscriptionProductName 订阅产品名称
  • 应用程序名称
  • skuId 的
  • 市场
  • 设备类型

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

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

按组分类 字符串 仅对指定字段应用数据聚合的语句。 可以指定以下字段:
  • 日期
  • subscriptionProductName 订阅产品名称
  • 应用程序名称
  • skuId 的
  • 市场
  • 设备类型

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

请求示例

以下示例演示如何获取订阅加载项购置数据。 将 applicationId 值替换为应用的相应应用商店 ID。

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions?applicationId=9NBLGGGZ5QDR&startDate=2017-07-07&endDate=2017-07-08 HTTP/1.1
Authorization: Bearer <your access token>

响应

响应体

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

订阅获取值

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

价值 类型 DESCRIPTION
日期 字符串 用于获取数据的日期范围中的第一个日期。 如果请求指定了某一天,此值就是该日期。 如果请求指定了一周、月或其他日期范围,则此值是该日期范围内的第一个日期。
订阅产品 ID 字符串 要为其检索购置数据的订阅加载项的 Store ID
订阅产品名称 字符串 订阅加载项的显示名称。
应用ID 字符串 您正在为其检索订阅加载项获取数据的应用程序,其应用商店 ID 为
应用程序名称 字符串 应用的显示名称。
skuId 的 字符串 要为其检索购置数据的订阅加载项的 SKU ID。
设备类型 字符串 以下字符串之一,指定完成购置的设备类型:
  • 个人电脑
  • 电话
  • Console-Xbox One
  • Console-Xbox 系列 X
  • 物联网
  • Holographic
  • 未知
市场 字符串 发生收购的市场 ISO 3166 国家/地区代码。
货币代码 字符串 ISO 4217 格式的货币代码,用于表示税前销售总额。
税前总销售额 整数 货币代码值定义的本地货币总销售额。
总活跃计数 整数 指定时间段内活动订阅总数。 这相当于 goodStandingActiveCountpendingGraceActiveCountgraceActiveCount 和 lockedActiveCount 值的总和。
总流失数量 整数 在指定时间段内停用的订阅总数。 这相当于 billingChurnCountnonRenewalChurnCountrefundChurnCountchargebackChurnCountearlyChurnCountotherChurnCount 值的总和。
新计数 整数 指定时间段内的新订阅购置次数,包括试用。
续订次数 整数 指定时间段内订阅续订数,包括用户发起的续订和自动续订。
良好状态的活跃数量 整数 在指定时间段内处于活动状态的订阅数,其到期日期为 >= 查询的 endDate 值。
待处理宽限活动计数 整数 指定时间段内处于使用中状态,但存在计费故障,且订阅到期日期 >= 查询的 endDate 值的订阅数。
宽限活跃计数 整数 在指定时间段内处于活动状态但计费失败的订阅数,以及以下位置:
  • 订阅到期日期是 < 查询的 endDate 值。
  • 宽限期的结束时间 = >endDate 值。
锁定活动计数 整数 指定时间段内处于“催缴”状态(即,订阅即将过期,且 Microsoft 正尝试获取自动续订此订阅所需的款项)且符合以下条件的订阅数:
  • 订阅到期日期是 < 查询的 endDate 值。
  • 宽限期的结束时间 = <endDate 值。
billingChurnCount 整数 由于无法处理计费费用以及以前处于扣扣状态的订阅,在指定时间段内停用的订阅数。
非续订客户流失数量 整数 在指定时间段内,由于未续订而被停用的订阅数量。
退款流失次数 整数 在指定时间段内因为已退款而被停用的订阅数。
chargebackChurnCount 整数 因付款撤销而在指定时间段内停用的订阅数量。
earlyChurnCount 整数 在指定时间段内停用的订阅数量,这些订阅在停用时处于良好状态。
otherChurnCount 整数 由于其他原因,在指定时间段内取消的订阅数。

请求和响应示例

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

示例请求

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

示例响应

{
    "Value": [
        {
            "date": "2022-04-18",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "grossSalesBeforeTax": 3460656.260391250,
            "totalActiveCount": 20211321,
            "totalChurnCount": 5605,
            "newCount": 3810366,
            "renewCount": 12102044,
            "goodStandingActiveCount": 17893664,
            "pendingGraceActiveCount": 2255792,
            "graceActiveCount": 61833,
            "lockedActiveCount": 32,
            "billingChurnCount": 4,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 2717,
            "otherChurnCount": 2884
        },
        {
            "date": "2022-04-18",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Unknown",
            "grossSalesBeforeTax": 2342.580615228,
            "totalActiveCount": 50550,
            "totalChurnCount": 7,
            "newCount": 8312,
            "renewCount": 31446,
            "goodStandingActiveCount": 44047,
            "pendingGraceActiveCount": 6503,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 5,
            "otherChurnCount": 2
        }
    ],
    "TotalCount": 2
}

示例请求

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2021&endDate=04/20/2022&top=10&skip=0&orderby=date&groupby=date,subscriptionProductName,applicationName,skuId,market,deviceType&aggregationLevel=week
HTTP/1.1
Authorization: Bearer <your access token>

示例响应

{
    "Value": [
        {
            "date": "2022-04-18",
            "subscriptionProductName": "realms.subscription.monthly.10player.01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "skuId": "0100",
            "market": "IT",
            "deviceType": "Console-Xbox One",
            "grossSalesBeforeTax": 0.0,
            "totalActiveCount": 0,
            "totalChurnCount": 0,
            "newCount": 2,
            "renewCount": 0,
            "goodStandingActiveCount": 0,
            "pendingGraceActiveCount": 0,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 0,
            "otherChurnCount": 0
        },
        {
            "date": "2022-04-18",
            "subscriptionProductName": "realms.subscription.monthly.10player.01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "skuId": "0100",
            "market": "NO",
            "deviceType": "Unknown",
            "grossSalesBeforeTax": 0.0,
            "totalActiveCount": 0,
            "totalChurnCount": 0,
            "newCount": 0,
            "renewCount": 13,
            "goodStandingActiveCount": 0,
            "pendingGraceActiveCount": 0,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 0,
            "otherChurnCount": 0
        },
        {
            "date": "2022-04-18",
            "subscriptionProductName": "realms.subscription.monthly.10player.02",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "skuId": "0100",
            "market": "CA",
            "deviceType": "Unknown",
            "grossSalesBeforeTax": 0.0,
            "totalActiveCount": 152,
            "totalChurnCount": 0,
            "newCount": 0,
            "renewCount": 270,
            "goodStandingActiveCount": 133,
            "pendingGraceActiveCount": 19,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 0,
            "otherChurnCount": 0
        }
    ],
    "TotalCount": 3
}