获取所有应用
在 Microsoft Store 提交 API 中使用此方法,可检索注册合作伙伴中心帐户的应用的数据。
必备条件
若要使用此方法,首先需要执行以下操作:
- 如果尚未开始操作,请先完成 Microsoft Store 提交 API 的所有先决条件。
- 获取 Azure AD 访问令牌,以供在此方法的请求标头中使用。 获取访问令牌后,在它到期前,你有 60 分钟的使用时间。 该令牌到期后,可以获取新的令牌。
请求
此方法具有以下语法。 请参阅以下部分,获取标头和请求正文的使用示例和描述。
方法 | 请求 URI |
---|---|
GET | https://manage.devcenter.microsoft.com/v1.0/my/applications |
请求头
标头 | 类型 | 说明 |
---|---|---|
授权 | 字符串 | 必需。 Azure AD 访问令牌的格式为 Bearertoken<>。 |
请求参数
此方法的所有请求参数均为选填。 如果不填写参数即调用此方法,则响应将包含注册到帐户的前 10 个应用的数据。
参数 | 类型 | 描述 | 必须 |
---|---|---|---|
top | int | 要在请求中返回的项数(即,要返回的应用数)。 如果帐户具有的应用超过在查询中指定的值,响应正文将包括可追加到方法 URI 的相对 URI 路径,用于请求下一页数据。 | 否 |
skip | int | 返回剩余项之前,在查询中绕过的项数。 使用此参数分页浏览数据集。 例如,top=10 和 skip=0 可检索项目 1 到 10,top=10 和 skip=10 可检索项目 11 到 20,依此类推。 | 否 |
请求正文
请勿为此方法提供请求正文。
请求示例
以下示例演示了如何检索注册到帐户的前 10 个应用。
GET https://manage.devcenter.microsoft.com/v1.0/my/applications HTTP/1.1
Authorization: Bearer <your access token>
以下示例演示了如何检索注册到帐户的所有应用的相关信息。 首先,获取排名前 10 的应用:
GET https://manage.devcenter.microsoft.com/v1.0/my/applications?top=10 HTTP/1.1
Authorization: Bearer <your access token>
然后递归调用 GET https://manage.devcenter.microsoft.com/v1.0/my/{@nextLink}
,直至 {@nextlink}
为 null 或在响应中不存在。 例如:
GET https://manage.devcenter.microsoft.com/v1.0/my/applications?skip=10&top=10 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/applications?skip=20&top=10 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/applications?skip=30&top=10 HTTP/1.1
Authorization: Bearer <your access token>
如果你已经知道帐户中拥有的应用总数,则只需将该数字传递到 top 参数中即可获取有关所有应用的信息。
GET https://manage.devcenter.microsoft.com/v1.0/my/applications?top=23 HTTP/1.1
Authorization: Bearer <your access token>
响应
以下示例演示了注册到开发人员帐户前 10 个应用(应用总数为 21 个)的成功请求返回的 JSON 响应正文。 为简便起见,此示例仅显示该请求返回的前两个应用。 有关响应正文中这些值的详细信息,请参阅以下部分。
{
"@nextLink": "applications?skip=10&top=10",
"value": [
{
"id": "9NBLGGH4R315",
"primaryName": "Contoso sample app",
"packageFamilyName": "5224ContosoDeveloper.ContosoSampleApp_ng6try80pwt52",
"packageIdentityName": "5224ContosoDeveloper.ContosoSampleApp",
"publisherName": "CN=…",
"firstPublishedDate": "2016-03-11T01:32:11.0747851Z",
"pendingApplicationSubmission": {
"id": "1152921504621134883",
"resourceLocation": "applications/9NBLGGH4R315/submissions/1152921504621134883"
}
},
{
"id": "9NBLGGH29DM8",
"primaryName": "Contoso sample app 2",
"packageFamilyName": "5224ContosoDeveloper.ContosoSampleApp2_ng6try80pwt52",
"packageIdentityName": "5224ContosoDeveloper.ContosoSampleApp2",
"publisherName": "CN=…",
"firstPublishedDate": "2016-03-12T01:49:11.0747851Z",
"lastPublishedApplicationSubmission": {
"id": "1152921504621225621",
"resourceLocation": "applications/9NBLGGH29DM8/submissions/1152921504621225621"
}
// Next 8 apps are omitted for brevity ...
}
],
"totalCount": 21
}
响应正文
值 | 类型 | 说明 |
---|---|---|
value | 数组 | 包含有关每个注册到帐户的应用的对象组。 有关每个对象中的数据的详细信息,请参阅应用程序资源。 |
@nextLink | string | 如果存在数据的其他页,此字符串中包含可附加到基本 https://manage.devcenter.microsoft.com/v1.0/my/ 请求 URI 的相对路径,用于请求下一页数据。 例如,如果初始请求正文的 top 参数设置为 10,但有 20 个应用注册到你的帐户,响应正文将包含 applications?skip=10&top=10 的 @nextLink 值,指示你可以调用 https://manage.devcenter.microsoft.com/v1.0/my/applications?skip=10&top=10 请求接下来的 10 个应用。 |
totalCount | int | 查询的数据结果中的总行数(即注册到帐户的应用总数)。 |
错误代码
如果无法成功完成请求,该响应中会包含以下 HTTP 错误代码之一。
错误代码 | 说明 |
---|---|
404 | 没有找到任何应用。 |
409 | 应用使用的合作伙伴中心功能当前不受 Microsoft Store 提交 API 支持。 |