在 Microsoft 应用商店提交 API 中使用此方法列出注册到合作伙伴中心帐户的应用的加载项。
先决条件
若要使用此方法,首先需要执行以下操作:
- 如果尚未这样做,请完成Microsoft应用商店提交 API 的所有 先决条件 。
- 在请求标头中获取 Azure AD 访问令牌 以用于此方法。 获取访问令牌后,在它到期前,你有 60 分钟的使用时间。 令牌过期后,可以获取一个新令牌。
请求
此方法具有以下语法。 有关标头和请求正文的使用示例和说明,请参阅以下部分。
方法 | 请求 URI |
---|---|
获取 | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/listinappproducts |
请求标头
标题 | 类型 | DESCRIPTION |
---|---|---|
授权 | 字符串 | 必填。 Azure AD 访问令牌的格式为 Bearer<token>。 |
请求参数
名称 | 类型 | DESCRIPTION | 必选 |
---|---|---|---|
应用ID | 字符串 | 要检索某个应用的加载项的应用商店 ID。 有关应用商店 ID 的详细信息,请参阅 “查看应用标识详细信息”。 | 是的 |
顶部 | 整数 (int) | 请求中要返回的项目数(即请求中要返回的加载项数)。 如果应用具有比在查询中指定的值更多的加载项,响应正文将包含一个相对 URI 路径,可以追加到方法 URI 以请求下一页数据。 | 否 |
跳过 | 整数 (int) | 在返回剩余项之前,查询中要绕过的项数。 使用此参数可分页浏览数据集。 例如,top=10 和 skip=0 检索项 1 到 10,top=10 和 skip=10 检索项 11 到 20,依依如此。 | 否 |
请求主体
请勿为此方法提供请求主体。
请求示例
以下示例演示如何列出应用的所有加载项。
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/listinappproducts HTTP/1.1
Authorization: Bearer <your access token>
以下示例演示如何列出应用的前 10 个加载项。
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/listinappproducts?top=10 HTTP/1.1
Authorization: Bearer <your access token>
响应
以下示例展示了成功请求一个包含 53 个加载项的应用的前 10 个加载项时返回的 JSON 响应正文。 为简洁起见,此示例仅显示请求返回的前三个加载项的数据。 有关响应正文中的值的更多详细信息,请参阅以下部分。
{
"@nextLink": "applications/9NBLGGH4R315/listinappproducts/?skip=10&top=10",
"value": [
{
"inAppProductId": "9NBLGGH4TNMP"
},
{
"inAppProductId": "9NBLGGH4TNMN"
},
{
"inAppProductId": "9NBLGGH4TNNR"
},
// Next 7 add-ons are omitted for brevity ...
],
"totalCount": 53
}
响应体
价值 | 类型 | DESCRIPTION |
---|---|---|
@nextLink | 字符串 | 如果有其他数据页,此字符串包含一个相对路径,可以附加到基础 https://manage.devcenter.microsoft.com/v1.0/my/ 请求 URI 上以请求下一页数据。 例如,如果初始请求正文的 顶部 参数设置为 10,但应用有 50 个加载项,则响应正文将包含一个 @nextLink 值 applications/{applicationid}/listinappproducts/?skip=10&top=10 ,指示可以调用 https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationid}/listinappproducts/?skip=10&top=10 以请求接下来的 10 个加载项。 |
价值 | 数组 | 列出指定应用每个加载项的应用商店 ID 的对象数组。 有关每个对象中的数据的详细信息,请参阅 加载项资源。 |
总计数 | 整数 (int) | 查询结果中数据行的总数(即用于指定应用的加载项的总数)。 |
错误代码
如果请求无法成功完成,响应将包含以下 HTTP 错误代码之一。
错误代码 | DESCRIPTION |
---|---|
404 | 找不到加载项。 |
409 | 加载项使用Microsoft应用商店提交 API 当前不支持的合作伙伴中心功能。 |