通过通道获取加载项转换

2025-06-10

在 Microsoft Store 分析 API 中使用此方法，根据特定日期范围和其他可选筛选条件按渠道获取加载项的汇总转换数据。

转换意味着用户（使用 Microsoft 账户登录）新获得了你的加载项的许可证（无论是收取费用还是免费提供）。
频道是客户到达应用程序详情页的方法（例如，通过应用商店或自定义应用促销活动）。

在合作伙伴中心的加载项购置报告中也提供了此信息。

先决条件

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

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

请求

请求语法

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

请求标头

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

请求参数

参数	类型	DESCRIPTION	必选
应用ID	字符串	您想要检索加载项转换数据的应用在应用商店的 ID 是。应用商店 ID 示例为 9WZDNCRFJ3Q8。	是的
应用内产品ID	字符串	您想要检索转换数据的加载项，其在应用商店中的 ID 为。	是的
开始日期	日期	要检索的日期范围内转换数据的开始日期。默认值为 2016/1/1。	否
结束日期	日期	需要检索的转换数据日期范围内的结束日期。默认值为当前日期。	否
顶部	整数 (int)	请求中要返回的数据行数。如果未指定，则最大值和默认值为 10000。如果查询中有更多行，响应正文将包含下一个链接，可用于请求下一页的数据。	否
跳过	整数 (int)	查询中要跳过的行数。使用此参数可分页浏览大型数据集。例如，top=10000 和 skip=0 检索前 10000 行数据，top=10000 和 skip=10000 检索接下来的 10000 行数据，依此等。	否
过滤器	字符串	用于筛选响应正文的一个或多个语句。每个语句都可以使用eq或ne运算符，并且可以使用and或or来组合语句。可以在筛选器语句中指定以下字符串。有关说明，请参阅本文中的转换值部分。应用程序名称应用类型自定义活动标识引用者UriDomain channelType （通道类型） storeClient 设备类型市场下面是一个示例筛选器参数：filter=deviceType eq “PC”。	否
聚合级别	字符串	指定要检索聚合数据的时间范围。可以是以下字符串之一：day、week 或 month。如果未指定，默认值为 day。	否
排序	字符串	对每个转换的结果数据值进行排序的语句。语法为 orderby=field [order]，field [order]，...。字段参数可以是以下字符串之一：日期应用程序名称应用内产品名称应用类型自定义活动标识引用者UriDomain channelType （通道类型） storeClient 设备类型市场顺序参数是可选的，可以是 asc 或 desc 来指定每个字段的升序或降序。默认值为 asc。下面是一个 orderby 字符串的示例：orderby=date,market	否
按组分类	字符串	仅对指定字段应用数据聚合的语句。可以指定以下字段：日期应用程序名称应用内产品名称应用类型自定义活动标识引用者UriDomain channelType （通道类型） storeClient 设备类型市场返回的数据行将包含 groupby 参数中指定的字段，如下所示：日期应用程序 ID 应用内产品ID 应用内产品名称转换次数点击次数 groupby 参数可与 aggregationLevel 参数一起使用。例如：groupby=ageGroup;market&aggregationLevel=week	否

请求示例

以下示例演示了获取应用转换数据的多个请求。将 applicationId 值替换为应用的应用商店 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>

响应

响应体

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

转换值

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

价值	类型	DESCRIPTION
日期	字符串	转换数据日期范围内的第一个日期。如果请求指定了某一天，此值就是该日期。如果请求指定了一周、月或其他日期范围，则此值是该日期范围内的第一个日期。
应用内产品ID	字符串	要为其检索转换数据的加载项应用商店 ID。
应用内产品名称	字符串	要检索转换数据的加载项显示名称。
应用ID	字符串	为检索转换数据的 App 所对应的应用商店 ID。
应用程序名称	字符串	您正在检索其转换数据的应用的显示名称。
应用类型	字符串	您正在检索转换数据的产品类型。对于此方法，支持的唯一值是加载项。
自定义活动ID	字符串	与应用关联的自定义应用促销活动的 ID 字符串。
引用者URI域	字符串	指定激活带有自定义应用推广活动 ID 的应用列表的域。
频道类型	字符串	以下字符串之一，指定转换的通道： CustomCampaignId 商店客流量其他
storeClient	字符串	发生转换的商店版本。目前，唯一受支持的值为 SFC。
设备类型	字符串	以下字符串之一：个人电脑电话 Console-Xbox One Console-Xbox 系列 X 物联网全息未知
市场	字符串	发生转换的市场 ISO 3166 国家/地区代码。
点击次数	数字	用户点击您应用列表链接的次数。
转换次数	数字	客户转换数。

请求和响应示例

以下代码片段演示了这些请求的一些示例请求和 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
}

附加收购报告
通过 Microsoft 应用商店服务获取分析数据
获取插件

通过

通过通道获取加载项转换

先决条件

请求

请求语法

请求标头

请求参数

请求示例

响应

响应体

转换值

请求和响应示例

示例请求

示例响应

示例请求

示例响应

相关主题

反馈

其他资源