在 Microsoft Store 分析 API 中使用此方法,以按通道获取应用程序在指定日期范围内及其他可选筛选器下的聚合转换。
- 转换 意味着客户(使用 Microsoft 帐户登录)已新获得了应用许可证(无论是付费还是免费提供)。
- 频道 是客户到达应用程序详情页的方法(例如,通过应用商店或 自定义应用促销活动)。
合作伙伴中心的 购置报告 中也提供了此信息。
先决条件
若要使用此方法,首先需要执行以下操作:
- 完成 Microsoft Store 分析 API 的所有先决条件(如果尚未这样做)。
- 获取 Azure AD 访问令牌,以供在此方法的请求标头中使用。 获取访问令牌后,在它到期前,你有 60 分钟的使用时间。 令牌过期后,可以获取一个新令牌。
请求
请求语法
方法 | 请求 URI |
---|---|
获取 | https://manage.devcenter.microsoft.com/v1.0/my/analytics/appchannelconversions |
请求标头
标题 | 类型 | DESCRIPTION |
---|---|---|
授权 | 字符串 | 必填。 Azure AD 访问令牌,形式为Bearer<token>。 |
请求参数
参数 | 类型 | DESCRIPTION | 必选 |
---|---|---|---|
应用ID | 字符串 | 您希望获取转换数据的应用的应用商店 ID 。 应用商店 ID 示例为 9WZDNCRFJ3Q8。 | 是的 |
开始日期 | 日期 | 要检索的日期范围内转换数据的开始日期。 默认值为 2016/1/1。 | 否 |
结束日期 | 日期 | 需要检索的转换数据日期范围内的结束日期。 默认值为当前日期。 | 否 |
顶部 | 整数 (int) | 请求中要返回的数据行数。 如果未指定,则最大值和默认值为 10000。 如果查询中有更多行,响应正文将包含下一个链接,可用于请求下一页的数据。 | 否 |
跳过 | 整数 (int) | 查询中要跳过的行数。 使用此参数可分页浏览大型数据集。 例如,top=10000 和 skip=0 检索前 10000 行数据,top=10000 和 skip=10000 检索接下来的 10000 行数据,依此等。 | 否 |
过滤器 | 字符串 | 用于筛选响应正文的一个或多个语句。 每个语句都可以使用eq或ne运算符,并且可以使用and或or来组合语句。 可以在筛选器语句中指定以下字符串。 有关说明,请参阅本文中的 转换值 部分。
下面是一个示例筛选器参数:filter=deviceType eq “PC”。 |
否 |
聚合级别 | 字符串 | 指定要检索聚合数据的时间范围。 可以是以下字符串之一:day、week 或 month。 如果未指定,默认值为 day。 | 否 |
排序 | 字符串 | 对每个转换的结果数据值进行排序的语句。 语法为 orderby=field [order],field [order],...。字段 参数可以是以下字符串之一:
顺序参数是可选的,可以是 asc 或 desc 来指定每个字段的升序或降序。 默认值为 asc。 下面是一个 orderby 字符串的示例:orderby=date,market |
否 |
按组分类 | 字符串 | 仅对指定字段应用数据聚合的语句。 可以指定以下字段:
返回的数据行将包含 groupby 参数中指定的字段,如下所示:
groupby 参数可与 aggregationLevel 参数一起使用。 例如:groupby=ageGroup;market&aggregationLevel=week |
否 |
请求示例
以下示例演示了获取应用转换数据的多个请求。 将 applicationId 值替换为应用的应用商店 ID。
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2017&endDate=2/1/2017&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2017&endDate=4/31/2017&skip=0&filter=market eq 'US' HTTP/1.1
Authorization: Bearer <your access token>
响应
响应体
价值 | 类型 | DESCRIPTION |
---|---|---|
价值 | 数组 | 包含应用的聚合转换数据的对象数组。 有关每个对象中的数据的详细信息,请参阅下面的 转换值 部分。 |
@nextLink | 字符串 | 如果有其他数据页,此字符串包含可用于请求下一页数据的 URI。 例如,如果请求的 顶部 参数设置为 10,但查询的转换数据超过 10 行,则返回此值。 |
总计数 | 整数 (int) | 查询的数据结果中的行总数。 |
转换值
Value 数组中的对象包含以下值。
价值 | 类型 | DESCRIPTION |
---|---|---|
日期 | 字符串 | 转换数据日期范围内的第一个日期。 如果请求指定了某一天,此值就是该日期。 如果请求指定了一周、月或其他日期范围,则此值是该日期范围内的第一个日期。 |
应用ID | 字符串 | 为检索转换数据的 App 所对应的 应用商店 ID。 |
应用程序名称 | 字符串 | 您正在检索其转换数据的应用的显示名称。 |
应用类型 | 字符串 | 您正在检索转换数据的产品类型。 对于此方法,唯一支持的值是 App。 |
自定义活动ID | 字符串 | 与应用关联的 自定义应用促销活动的 ID 字符串。 |
引用者URI域 | 字符串 | 指定激活带有自定义应用推广活动 ID 的应用列表的域。 |
频道类型 | 字符串 | 以下字符串之一,指定转换的通道:
|
storeClient | 字符串 | 发生转换的商店版本。 目前,唯一受支持的值为 SFC。 |
设备类型 | 字符串 | 以下字符串之一:
|
市场 | 字符串 | 发生转换的市场 ISO 3166 国家/地区代码。 |
点击次数 | 数字 | 用户点击您应用列表链接的次数。 |
转换次数 | 数字 | 客户转换数。 |
请求和响应示例
以下代码片段演示了这些请求的一些示例请求和 JSON 响应正文。
示例请求
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=06/23/2022&endDate=07/21/2022&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>
示例响应
{
"Value": [
{
"applicationId": "9NBLGGGZ5QDR",
"clickCount": 3089,
"conversionCount": 14
}
],
"@nextLink": "",
"TotalCount": 1
}
示例请求
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=06/19/2022&endDate=07/21/2022&skip=0&groupby=date,applicationName,customCampaignId,referrerUriDomain,channelType,storeClient,deviceType,market&filter=market eq 'US'
HTTP/1.1
Authorization: Bearer <your access token>
示例响应
{
"Value": [
{
"date": "2022-06-19",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "",
"referrerUriDomain": "Universal Client Store",
"channelType": "Store Traffic",
"storeClient": "SFC",
"deviceType": "PC",
"market": "US",
"clickCount": 13,
"conversionCount": 0
},
{
"date": "2022-06-20",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "",
"referrerUriDomain": "Universal Client Store",
"channelType": "Store Traffic",
"storeClient": "SFC",
"deviceType": "PC",
"market": "US",
"clickCount": 6,
"conversionCount": 0
},
{
"date": "2022-06-21",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "",
"referrerUriDomain": "Universal Client Store",
"channelType": "Store Traffic",
"storeClient": "SFC",
"deviceType": "PC",
"market": "US",
"clickCount": 4,
"conversionCount": 0
},
{
"date": "2022-06-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "",
"referrerUriDomain": "Universal Client Store",
"channelType": "Store Traffic",
"storeClient": "SFC",
"deviceType": "PC",
"market": "US",
"clickCount": 4,
"conversionCount": 0
},
],
"@nextLink": "",
"TotalCount": 4
}