在 Microsoft 商店分析 API 中使用此方法,获取应用附加组件在给定日期范围及其他可选筛选条件下的 JSON 格式汇总获取数据。 在合作伙伴中心的 加载项购置报告 中也提供了此信息。
先决条件
若要使用此方法,首先需要执行以下操作:
- 完成 Microsoft Store 分析 API 的所有先决条件(如果尚未这样做)。
- 获取 Azure AD 访问令牌,以供在此方法的请求标头中使用。 获取访问令牌后,在它到期前,你有 60 分钟的使用时间。 令牌过期后,可以获取一个新令牌。
请求
请求语法
方法 | 请求 URI |
---|---|
获取 | https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions |
请求标头
标题 | 类型 | DESCRIPTION |
---|---|---|
授权 | 字符串 | 必填。 Azure AD 访问令牌,形式为Bearer<token>。 |
请求参数
applicationId 或 inAppProductId 参数是必需的。 若要检索注册到应用的所有加载项的购置数据,请指定 applicationId 参数。 若要检索单个加载项的获取数据,请指定 inAppProductId 参数。 如果同时指定这两个参数,则忽略 applicationId 参数。
参数 | 类型 | DESCRIPTION | 必选 |
---|---|---|---|
应用ID | 字符串 | 要为其检索加载项购置数据的应用的 应用商店 ID。 | 是的 |
应用内产品ID | 字符串 | 要检索购置数据的加载项在应用商店中的 ID 为 。 | 是的 |
开始日期 | 日期 | 要检索的加载项购置数据日期范围中的开始日期。 默认值为当前日期。 | 否 |
结束日期 | 日期 | 要检索的附加组件获取数据日期范围的结束日期。 默认值为当前日期。 | 否 |
顶部 | 整数 (int) | 请求中要返回的数据行数。 如果未指定,则最大值和默认值为 10000。 如果查询中有更多行,响应正文将包含下一个链接,可用于请求下一页的数据。 | 否 |
跳过 | 整数 (int) | 查询中要跳过的行数。 使用此参数可分页浏览大型数据集。 例如,top=10000 和 skip=0 检索前 10000 行数据,top=10000 和 skip=10000 检索接下来的 10000 行数据,依此等。 | 否 |
过滤器 | 字符串 | 一个或多个用于筛选响应中行的语句。 有关详细信息,请参阅下面的 筛选器字段 部分。 | 否 |
聚合级别 | 字符串 | 指定要检索聚合数据的时间范围。 可以是以下字符串之一:day、week 或 month。 如果未指定,默认值为 day。 | 否 |
排序 | 字符串 | 对每个附加组件购买的结果数据值进行排序的语句。 语法为 orderby=field [order],field [order],...。字段 参数可以是以下字符串之一:
顺序参数是可选的,可以是 asc 或 desc 来指定每个字段的升序或降序。 默认值为 asc。 下面是一个 orderby 字符串的示例:orderby=date,market |
否 |
按组分类 | 字符串 | 仅对指定字段应用数据聚合的语句。 可以指定以下字段:
返回的数据行将包含 groupby 参数中指定的字段,如下所示:
groupby 参数可与 aggregationLevel 参数一起使用。 例如:&groupby=ageGroup,market&aggregationLevel=week |
否 |
筛选字段
请求的 筛选器 参数包含一个或多个语句,用于筛选响应中的行。 每个语句都包含一个字段和值,这些字段和值与 eq 或 ne 运算符相关联,可以使用 和 或 或组合语句。 下面是一些示例 筛选器 参数:
- filter=market eq 'US' 和性别 eq 'm'
- filter=(market ne 'US') and (gender ne 'Unknown') and (gender ne 'm') and (market ne 'NO') and (ageGroup ne 'greater than 55' or ageGroup ne 'less than 13')
有关支持字段的列表,请参阅下表。 字符串值必须用 筛选器 参数中的单引号括起来。
领域 | DESCRIPTION |
---|---|
获取类型 | 以下字符串之一:
|
年龄组 | 以下字符串之一:
|
storeClient | 以下字符串之一:
|
性别 | 以下字符串之一:
|
市场 | 一个字符串,其中包含发生收购的市场 ISO 3166 国家/地区代码。 |
osVersion | 以下字符串之一:
|
设备类型 | 以下字符串之一:
|
订单名称 | 一个字符串,指定用于兑换促销代码获取加载项的订单名称(仅当用户通过兑换促销代码获取加载项时适用)。 |
请求示例
以下示例演示了几种获取加载项购置数据的请求。 将 inAppProductId 和 applicationId 值替换为加载项或应用的相应应用商店 ID。
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?inAppProductId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?inAppProductId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=7/3/2015&top=100&skip=0&filter=market ne 'US' and gender ne 'Unknown' and gender ne 'm' and market ne 'NO' and ageGroup ne '>55' HTTP/1.1
Authorization: Bearer <your access token>
响应
响应体
价值 | 类型 | DESCRIPTION |
---|---|---|
价值 | 数组 | 包含汇总附加组件购置数据的对象数组。 有关每个对象中的数据的详细信息,请参阅下面的 附加组件获取值 章节。 |
@nextLink | 字符串 | 如果有其他数据页,此字符串包含可用于请求下一页数据的 URI。 例如,如果请求的 顶部 参数设置为 10000,但查询的加载项购置数据超过 10000 行,则返回此值。 |
总计数 | 整数 (int) | 查询的数据结果中的行总数。 |
附加购置值
Value 数组中的元素包含以下值。
价值 | 类型 | DESCRIPTION |
---|---|---|
日期 | 字符串 | 用于获取数据的日期范围中的第一个日期。 如果请求指定了某一天,此值就是该日期。 如果请求指定了一周、月或其他日期范围,则此值是该日期范围内的第一个日期。 |
应用内产品ID | 字符串 | 要为其检索购置数据的插件所对应的商店 ID。 |
应用内产品名称 | 字符串 | 加载项的显示名称。 仅当 aggregationLevel 参数设置为 天时,此值才会出现在响应数据中,除非在 groupby 参数中指定了 inAppProductName 字段。 |
应用ID | 字符串 | 你想要查询加载项购置数据的应用商店的应用 ID。 |
应用程序名称 | 字符串 | 应用的显示名称。 |
设备类型 | 字符串 | 完成收购的设备类型。 有关支持的字符串列表,请参阅上面的 筛选器字段 部分。 |
订单名称 | 字符串 | 订单的名称。 |
storeClient | 字符串 | 发生购置的应用商店的版本。 有关支持的字符串列表,请参阅上面的 筛选器字段 部分。 |
osVersion | 字符串 | 获取时的操作系统版本。 有关支持的字符串列表,请参阅上面的 筛选器字段 部分。 |
市场 | 字符串 | 发生收购的市场 ISO 3166 国家/地区代码。 |
性别 | 字符串 | 进行购置的用户的性别。 有关支持的字符串列表,请参阅上面的 筛选器字段 部分。 |
年龄组 | 字符串 | 进行购置的用户的年龄组。 有关支持的字符串列表,请参阅上面的 筛选器字段 部分。 |
获取类型 | 字符串 | 购置类型(免费、付费等)。 有关支持的字符串列表,请参阅上面的 筛选器字段 部分。 |
获取数量 | 整数 | 发生的收购次数。 |
请求和响应示例
以下代码片段演示了这些请求的示例请求和 JSON 响应正文。
示例请求
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>
示例响应
{
"Value": [
{
"applicationId": "9NBLGGGZ5QDR",
"inAppProductName": "Deluxe Collector's Edition",
"addonProductId": "9NBLGGAAGZDQ",
"date": "2022-07-29",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 18.12,
"purchasePriceLocalAmount": 18.12,
"purchaseTaxUSDAmount": 1.13,
"purchaseTaxLocalAmount": 1.13
},
{
"applicationId": "9NBLGGGZ5QDR",
"inAppProductName": "Episode 4",
"addonProductId": "9NAAAAAAAAAQ",
"date": "2017-01-07",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 4.147206,
"purchasePriceLocalAmount": 3.99,
"purchaseTaxUSDAmount": 0.686004,
"purchaseTaxLocalAmount": 0.66
},
{
"applicationId": "9NBLGGGZ5QDR",
"inAppProductName": "Deluxe Collector's Edition",
"addonProductId": "9NALGGGZ5QDQ",
"date": "2018-04-01",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 1.99,
"purchasePriceLocalAmount": 1.99,
"purchaseTaxUSDAmount": 0.0,
"purchaseTaxLocalAmount": 0.0
},
{
"applicationId": "9NBLGGGZ5QDR",
"inAppProductName": "Strategy Guide Episode 4",
"addonProductId": "9NBLGGGZ5QDQ",
"date": "2021-11-25",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 1.31902922876179,
"purchasePriceLocalAmount": 150.0,
"purchaseTaxUSDAmount": 0.114315866492689,
"purchaseTaxLocalAmount": 13.0
},
],
"TotalCount": 4,
"DataFreshnessTimestamp": "2022-07-29T05:54:00"
}
相关主题
- 附加收购报告
- 通过 Microsoft 应用商店服务 获取分析数据
- 获取按频道分列的附加组件转换
- 获取应用安装量
- 获取应用程序获取漏斗数据
- 按渠道获取应用转化