在 Microsoft Store 分析 API 中,在给定日期范围内使用此方法及其他可选筛选器,以获取应用收购渠道数据。 合作伙伴中心的 购置报告 中也提供了此信息。
先决条件
若要使用此方法,首先需要执行以下操作:
- 完成 Microsoft Store 分析 API 的所有先决条件(如果尚未这样做)。
- 获取 Azure AD 访问令牌,以供在此方法的请求标头中使用。 获取访问令牌后,在它到期前,你有 60 分钟的使用时间。 令牌过期后,可以获取一个新令牌。
请求
请求语法
| 方法 | 请求 URI |
|---|---|
| 获取 | https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel |
请求标头
| 标题 | 类型 | DESCRIPTION |
|---|---|---|
| 授权 | 字符串 | 必填。 Azure AD 访问令牌,形式为Bearer<token>。 |
请求参数
| 参数 | 类型 | DESCRIPTION | 必选 |
|---|---|---|---|
| 应用ID | 字符串 | 要为其检索购置漏斗数据的应用 |
是的 |
| 开始日期 | 日期 | 要检索的购置漏斗数据日期范围内的开始日期。 默认值为当前日期。 | 否 |
| 结束日期 | 日期 | 要检索的购置漏斗数据日期范围内的结束日期。 默认值为当前日期。 | 否 |
| 过滤器 | 字符串 | 一个或多个用于筛选响应中行的语句。 有关详细信息,请参阅下面的 筛选器字段 部分。 | 否 |
筛选字段
请求的 筛选器 参数包含一个或多个语句,用于筛选响应中的行。 每个语句都包含一个字段和值,这些字段和值与 eq 或 ne 运算符相关联,可以使用 和 或 或组合语句。
支持以下筛选器字段。 字符串值必须用 筛选器 参数中的单引号括起来。
| 领域 | DESCRIPTION |
|---|---|
| 活动编号 | 与购置关联的 自定义应用促销活动的 ID 字符串。 |
| 市场 | 一个字符串,其中包含发生收购的市场 ISO 3166 国家/地区代码。 |
| 设备类型 | 以下字符串之一,指定发生购置的设备类型:
|
| 年龄组 | 以下字符串之一,指定完成购置的用户的年龄组:
|
| 性别 | 以下字符串之一,指定完成购置的用户的性别:
|
请求示例
以下示例演示了针对应用获取途径数据的多个请求。 将 applicationId 值替换为应用的应用商店 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>
响应
响应体
| 价值 | 类型 | DESCRIPTION |
|---|---|---|
| 价值 | 数组 | 包含应用的购置漏斗数据的对象数组。 有关每个对象所含数据的详情,请参阅下面的 漏斗值 部分。 |
| 总计数 | 整数 (int) | Value 数组中的对象总数。 |
漏斗值
Value 数组中的对象包含以下值。
| 价值 | 类型 | DESCRIPTION |
|---|---|---|
| 度量类型 | 字符串 | 以下字符串之一,指定此对象中包含的漏斗数据
|
| 用户数量 | 字符串 | 执行 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
}