获取应用购置漏斗数据

  • 项目

在Microsoft存储分析 API 中使用此方法，在给定日期范围和其他可选筛选器期间获取应用程序的获取漏斗数据。 还可以在合作伙伴中心的购置报告中获取此信息。

先决条件

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

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

请求

请求语法

方法 请求 URI
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel

请求头

标头 类型 说明
授权 字符串 必需。 Azure AD 访问令牌的格式为 Bearertoken<>。

请求参数

参数 类型 描述 必需
applicationId string 要为其检索购置漏斗数据的应用的应用商店 ID。 Store ID 示例：9WZDNCRFJ3Q8。 是
startDate date 要检索的购置漏斗数据日期范围内的开始日期。 默认是当前日期。 否
endDate date 要检索的购置漏斗数据日期范围内的结束日期。 默认是当前日期。 否
filter string 在响应中筛选行的一条或多条语句。 有关详细信息，请参阅下面的筛选器字段部分。 否

 

筛选器字段

请求中的 filter 参数包含一条或多条用来在响应中筛选行的语句。 每条语句包含的字段和值使用 eq 或 ne 运算符进行关联，并且语句可以使用 and 或 or 进行组合。

支持以下筛选器字段。 filter 参数中的字符串值必须使用单引号引起来。

字段 说明
campaignId 与购置关联的自定义应用促销活动的 ID 字符串。
market 包含发生购置之市场的 ISO 3166 国家/地区代码的字符串。
deviceType 以下字符串之一，指定发生购置的设备类型：
  • 电脑
  • Phone
  • Console-Xbox One
  • Console-Xbox 系列 X
  • IoT
  • Holographic
  • Unknown
ageGroup 以下字符串之一，指定完成购置的用户的年龄组：
  • 0 – 17
  • 18 – 24
  • 25 – 34
  • 35 – 49
  • 50 个或多个
  • Unknown
gender 以下字符串之一，指定完成购置的用户的性别：
  • M
  • F
  • Unknown

请求示例

以下示例演示了获取应用的获取漏斗数据的多个请求。 将 applicationId 值替换为你的应用的 Store ID。

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel?applicationId=9NBLGGGZ5QDR&startDate=8/1/2016&endDate=8/31/2016&filter=market eq 'US' and gender eq 'm'  HTTP/1.1
Authorization: Bearer <your access token>

响应

响应正文

值 类型 说明
Value array 包含应用的购置漏斗数据的对象数组。 有关每个对象中的数据的详细信息，请参阅 下面的漏斗值 部分。
TotalCount int Value 数组中的对象总数。

漏斗值

Value 数组中的对象包含以下值。

值 类型 描述
MetricType string 以下字符串之一，指定 此对象中包含的漏斗数据类型 ：
  • PageView
  • 获取
  • 安装
  • 使用情况
UserCount string 执行 MetricType 值指定的漏斗步骤的用户数。

请求和响应示例

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

示例请求

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

示例响应

{
    "Value": [
        {
            "MetricType": "PageView",
            "UserCount": 6214
        },
        {
            "MetricType": "Acquisition",
            "UserCount": 1502
        },
        {
            "MetricType": "Usage",
            "UserCount": 606
        },
        {
            "MetricType": "Install",
            "UserCount": 977
        }
    ],
    "TotalCount": 4
}

示例请求

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel?applicationId=9NBLGGGZ5QDR&startDate=12/19/2021&endDate=12/21/2021&filter=market eq 'US' and gender eq 'm'
HTTP/1.1
Authorization: Bearer <your access token>

示例响应

{
    "Value": [
        {
            "MetricType": "PageView",
            "UserCount": 10
        },
        {
            "MetricType": "Acquisition",
            "UserCount": 8
        },
        {
            "MetricType": "Usage",
            "UserCount": 5
        },
        {
            "MetricType": "Install",
            "UserCount": 3
        }
    ],
    "TotalCount": 4
}