获取应用的加载项

  • 项目

在 Microsoft Store 提交 API 中使用此方法，为注册到合作伙伴中心帐户的应用列出加载项。

必备条件

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

  • 如果尚未开始操作，请先完成 Microsoft Store 提交 API 的所有先决条件。
  • 获取 Azure AD 访问令牌，以供在此方法的请求标头中使用。 获取访问令牌后，在它到期前，你有 60 分钟的使用时间。 该令牌到期后，可以获取新的令牌。

请求

此方法具有以下语法。 请参阅以下部分，获取标头和请求正文的使用示例和描述。

方法 请求 URI
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/listinappproducts

请求头

标头 类型 说明
授权 字符串 必需。 Azure AD 访问令牌的格式为 Bearertoken<>。

请求参数

名称 类型 说明 必需
applicationId 字符串 要检索加载项的应用的应用商店 ID。 有关应用商店 ID 的详细信息，请参阅查看应用标识详细信息。 是
top int 要在请求中返回的项数（即，要返回的加载项数）。 如果应用具有的加载项超过在查询中指定的值，响应正文将包括可追加到方法 URI 的相对 URI 路径，用于请求下一页数据。 否
skip 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>

响应

以下示例演示了应用前 10 个加载项（加载项总数为 53 个）的成功请求返回的 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
}

响应正文

值 类型 说明
@nextLink string 如果存在数据的其他页，此字符串中包含可附加到基本 https://manage.devcenter.microsoft.com/v1.0/my/ 请求 URI 的相对路径，用于请求下一页数据。 例如，如果初始请求正文的 top 参数设置为 10，但应用有 50 个加载项，响应正文将包含 applications/{applicationid}/listinappproducts/?skip=10&top=10 的 @nextLink 值，指示你可以调用 https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationid}/listinappproducts/?skip=10&top=10 请求接下来的 10 个加载项。
value 数组 一组列出指定应用的每个加载项应用商店 ID 的对象。 有关每个对象中的数据的详细信息，请参阅加载项资源。
totalCount int 查询的数据结果中的总行数（即，指定应用的加载项总数）。

错误代码

如果无法成功完成请求，该响应中会包含以下 HTTP 错误代码之一。

错误代码 说明
404 找不到任何加载项。
409 加载项使用的合作伙伴中心功能当前不受 Microsoft Store 提交 API 支持。