通过通道获取加载项转换
使用 Microsoft Store 分析 API 中的此方法，可获取给定日期范围内和使用其他可选筛选器时的某个加载项的渠道聚合转换。
- 转换意味着（使用 Microsoft 帐户登录的）客户新获得了加载项许可证（无论收费还是免费提供）。
- 渠道是指客户到达应用列表页面的方法（例如通过 Microsoft Store 或自定义应用促销活动）。
还可以在合作伙伴中心的加载项购置报告中获取此信息。
先决条件
若要使用此方法，首先需要执行以下操作：
- 完成 Microsoft Store 分析 API 的所有先决条件（如果尚未这样做）。
- 获取 Azure AD 访问令牌，以供在此方法的请求标头中使用。 获取访问令牌后，在它到期前，你有 60 分钟的使用时间。 该令牌到期后，可以获取新的令牌。
请求
请求语法
| 方法 | 请求 URI |
|---|---|
| GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions |
请求头
| 标头 | 类型 | 说明 |
|---|---|---|
| 授权 | 字符串 | 必需。 Azure AD 访问令牌的格式为 Bearertoken<>。 |
请求参数
| 参数 | 类型 | 描述 | 必需 |
|---|---|---|---|
| applicationId | string | 要检索其加载项转换数据的应用的 Store ID。 Store ID 示例：9WZDNCRFJ3Q8。 | 是 |
| inAppProductId | string | 要检索其转换数据的加载项的 Store ID。 | 是 |
| startDate | date | 要检索的转换数据日期范围中的开始日期。 默认值为 1/1/2016。 | 否 |
| endDate | date | 要检索的转换数据日期范围中的结束日期。 默认是当前日期。 | 否 |
| top | int | 要在请求中返回的数据行数。 如果未指定，最大值和默认值为 10000。 当查询中存在多行数据时，响应正文中包含的下一个链接可用于请求下一页数据。 | 否 |
| skip | int | 要在查询中跳过的行数。 使用此参数可以浏览较大的数据集。 例如，top=10000 和 skip=0，将检索前 10000 行数据；top=10000 和 skip=10000，将检索之后的 10000 行数据，依此类推。 | 否 |
| filter | string | 一条或多条用来筛选响应正文的语句。 每条语句可以使用 eq 或 ne 运算符，多条语句还可以使用 and 或 or 进行组合。 可以在筛选器语句中指定以下字符串。 有关说明，请参阅本文中的转换值部分。
下面是一个示例 filter 参数：filter=deviceType eq 'PC'。 |
否 |
| aggregationLevel | string | 指定用于检索聚合数据的时间范围。 可以是以下字符串之一：day、week 或 month。 如果未指定，默认值为 day。 | 否 |
| orderby | string | 一个用来对每个转换的结果数据值进行排序的语句。 语法为 orderby=field [order],field [order],...，其中 field 参数可以是以下字符串之一：
order 参数是可选的，可以是 asc 或 desc，用于指定每个字段的升序或降序排列。 默认值为 asc。 下面是一个 orderby 字符串的示例：orderby=date,market |
否 |
| groupby | string | 仅将数据聚合应用于指定字段的语句。 可以指定以下字段：
返回的数据行将包含 groupby 参数中指定的字段以及以下字段：
groupby 参数可以与 aggregationLevel 参数结合使用。 例如：groupby=ageGroup,market&aggregationLevel=week |
否 |
请求示例
如下示例展示了一些用来获取应用转换数据的请求。 将 applicationId 值替换为你的应用的 Store ID。
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?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/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2017&endDate=4/31/2017&skip=0&filter=market eq 'US' HTTP/1.1
Authorization: Bearer <your access token>
响应
响应正文
| 值 | 类型 | 说明 |
|---|---|---|
| Value | 数组 | 一组包含加载项聚合转换数据的对象。 有关每个对象中的数据的更多信息，请参阅下面的转换值部分。 |
| @nextLink | string | 如果存在其他数据页，则此字符串包含一个你可用来请求下一页数据的 URI。 例如，当请求的 top 参数设置为 10，但查询的转换数据超过 10 行时，将会返回此值。 |
| TotalCount | int | 查询的数据结果中的行总数。 |
转换值
Value 数组中的对象包含以下值。
| 值 | 类型 | 说明 |
|---|---|---|
| date | string | 转换数据的日期范围内的第一个日期。 如果请求指定了某一天，此值就是该日期。 如果请求指定了一周、月或其他日期范围，此值是该日期范围内的第一个日期。 |
| inAppProductId | string | 要检索其转换数据的加载项的 Store ID。 |
| inAppProductName | string | 要检索其转换数据的加载项的显示名称。 |
| applicationId | string | 要检索转换数据的应用的 Microsoft Store ID。 |
| applicationName | string | 要检索其转换数据的应用的显示名称。 |
| appType | string | 要检索其转换数据的产品的类型。 对于此方法，支持的唯一一个值为 Add-On。 |
| customCampaignId | string | 与应用关联的自定义应用促销活动的 ID 字符串。 |
| referrerUriDomain | string | 指定具有已激活的自定义应用促销活动 ID 的应用列表所在的域。 |
| channelType | string | 用来指定转换渠道的以下字符串之一：
|
| storeClient | string | 发生转换的 Microsoft Store 的版本。 目前支持的唯一一个值为 SFC。 |
| deviceType | string | 以下字符串之一：
|
| market | string | 发生转换的市场的 ISO 3166 国家/地区代码。 |
| clickCount | 数字 | 客户单击应用列表链接的次数。 |
| conversionCount | 数字 | 客户转换次数。 |
请求和响应示例
如下代码片段展示了这些请求的一些示例请求和 JSON 响应正文。
示例请求
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2019&endDate=12/20/2021&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>
示例响应
{
"Value": [
{
"inAppProductId": "9NN2HW33ZB2G",
"applicationId": "9NBLGGGZ5QDR",
"clickCount": 220636,
"conversionCount": 154
},
{
"inAppProductId": "9PN07J0WC18B",
"applicationId": "9NBLGGGZ5QDR",
"clickCount": 277061,
"conversionCount": 187
}
],
"@nextLink": "",
"TotalCount": 2
}
示例请求
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2021&endDate=12/20/2021&top=10&skip=0&groupby=date,applicationName,inAppProductName,appType,customCampaignId,referrerUriDomain,channelType,storeClient,deviceType,market
HTTP/1.1
Authorization: Bearer <your access token>
示例响应
{
"Value": [
{
"inAppProductId": "9WZDNCRCWW61",
"inAppProductName": "SeasonPass0",
"appType": "Add-On",
"date": "2022-06-21",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "mcg_mahjong_othergames",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "BR",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW5H",
"inAppProductName": "OEMFreePurchase",
"appType": "Add-On",
"date": "2022-07-06",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "mcg_solitaire_othergames",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "AT",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW5Z",
"inAppProductName": "Episode1Combo",
"appType": "Add-On",
"date": "2022-07-09",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "vungle",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "CZ",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW5H",
"inAppProductName": "OEMFreePurchase",
"appType": "Add-On",
"date": "2022-07-09",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "vungle",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "CZ",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW4Z",
"inAppProductName": "Episode1Grandfathered",
"appType": "Add-On",
"date": "2022-07-11",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "|autosuggest",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "ES",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW5W",
"inAppProductName": "Episode2Combo",
"appType": "Add-On",
"date": "2022-07-11",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "vungle",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "CZ",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW4P",
"inAppProductName": "SeasonPass24",
"appType": "Add-On",
"date": "2022-07-12",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "vungle",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "CZ",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW5H",
"inAppProductName": "OEMFreePurchase",
"appType": "Add-On",
"date": "2022-07-13",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "9wzdncrfjbd8",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "CA",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW61",
"inAppProductName": "SeasonPass0",
"appType": "Add-On",
"date": "2022-07-17",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "scom-web-store",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "US",
"clickCount": 1,
"conversionCount": 1
}
],
"@nextLink": "",
"TotalCount": 9
}
相关主题
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈