使用 Microsoft Store 提交 API 的此方法,以检索所有注册到您的合作伙伴中心帐户的应用程序的所有加载项的数据。
先决条件
若要使用此方法,首先需要执行以下操作:
- 如果尚未这样做,请完成Microsoft应用商店提交 API 的所有 先决条件 。
- 获取 Azure AD 访问令牌,以供在此方法的请求标头中使用。 获取访问令牌后,在它到期前,你有 60 分钟的使用时间。 令牌过期后,可以获取一个新令牌。
请求
此方法具有以下语法。 有关标头和请求正文的使用示例和说明,请参阅以下部分。
方法 | 请求 URI |
---|---|
获取 | https://manage.devcenter.microsoft.com/v1.0/my/inappproducts |
请求标头
标题 | 类型 | DESCRIPTION |
---|---|---|
授权 | 字符串 | 必填。 Azure AD 访问令牌,形式为Bearer<token>。 |
请求参数
此方法的所有请求参数都是可选的。 如果不使用参数调用此方法,响应将包含所有注册到您帐户的应用的所有附加组件的数据。
参数 | 类型 | DESCRIPTION | 必选 |
---|---|---|---|
顶部 | 整数 (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/inappproducts HTTP/1.1
Authorization: Bearer <your access token>
以下示例演示如何仅检索前 10 个加载项。
GET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts?top=10 HTTP/1.1
Authorization: Bearer <your access token>
响应
以下示例演示了通过成功请求向开发人员帐户注册的前 5 个加载项返回的 JSON 响应正文,该加载项总共有 1072 个。 为简洁起见,此示例仅显示请求返回的前两个加载项的数据。 有关响应正文中的值的更多详细信息,请参阅以下部分。
{
"@nextLink": "inappproducts/?skip=5&top=5",
"value": [
{
"applications": {
"value": [
{
"id": "9NBLGGH4R315",
"resourceLocation": "applications/9NBLGGH4R315"
}
],
"totalCount": 1
},
"id": "9NBLGGH4TNMP",
"productId": "a8b8310b-fa8d-4da0-aca0-577ef6dce4dd",
"productType": "Consumable",
"pendingInAppProductSubmission": {
"id": "1152921504621243619",
"resourceLocation": "inappproducts/9NBLGGH4TNMP/submissions/1152921504621243619"
},
"lastPublishedInAppProductSubmission": {
"id": "1152921504621243705",
"resourceLocation": "inappproducts/9NBLGGH4TNMP/submissions/1152921504621243705"
}
},
{
"applications": {
"value": [
{
"id": "9NBLGGH4R315",
"resourceLocation": "applications/9NBLGGH4R315"
}
],
"totalCount": 1
},
"id": "9NBLGGH4TNMN",
"productId": "6a3c9788-a350-448a-bd32-16160a13018a",
"productType": "Consumable",
"pendingInAppProductSubmission": {
"id": "1152921504621243538",
"resourceLocation": "inappproducts/9NBLGGH4TNMN/submissions/1152921504621243538"
},
"lastPublishedInAppProductSubmission": {
"id": "1152921504621243106",
"resourceLocation": "inappproducts/9NBLGGH4TNMN/submissions/1152921504621243106"
}
},
// Other add-ons omitted for brevity...
],
"totalCount": 1072
}
响应体
价值 | 类型 | DESCRIPTION |
---|---|---|
@nextLink | 字符串 | 如果有其他数据页,此字符串包含一个相对路径,可以附加到基础 https://manage.devcenter.microsoft.com/v1.0/my/ 请求 URI 上以请求下一页数据。 例如,如果初始请求正文的 顶部 参数设置为 10,但帐户中注册了 100 个加载项,则响应正文将包含一个 @nextLink 值 inappproducts?skip=10&top=10 ,指示可以调用 https://manage.devcenter.microsoft.com/v1.0/my/inappproducts?skip=10&top=10 以请求接下来的 10 个加载项。 |
价值 | 数组 | 一个数组,其中包含提供有关每个加载项的信息的对象。 有关详细信息,请参阅 加载项资源。 |
总计数 | 整数 (int) | 响应正文中 数组的 |
错误代码
如果请求无法成功完成,响应将包含以下 HTTP 错误代码之一。
错误代码 | DESCRIPTION |
---|---|
404 | 找不到加载项。 |
409 | 应用或加载项使用Microsoft应用商店提交 API当前不支持的合作伙伴中心 |