更新应用提交
在 Microsoft 应用商店提交 API 中使用此方法更新现有应用提交。 使用此方法成功更新提交后,必须确认提交才可以实现引入和发布。
有关此方法如何适用通过使用 Microsoft Store 提交 API 创建应用提交过程的详细信息,请参阅管理应用提交。
必备条件
若要使用此方法,首先需要执行以下操作:
- 如果尚未开始操作,请先完成 Microsoft Store 提交 API 的所有先决条件。
- 获取 Azure AD 访问令牌,以供在此方法的请求标头中使用。 获取访问令牌后,在它到期前,你有 60 分钟的使用时间。 该令牌到期后,可以获取新的令牌。
- 为某个应用创建提交。 可以在合作伙伴中心执行此操作,也可以通过使用创建应用提交方法执行此操作。
请求
此方法具有以下语法。 请参阅以下部分,获取标头和请求正文的使用示例和描述。
方法 | 请求 URI |
---|---|
PUT | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} |
请求头
标头 | 类型 | 说明 |
---|---|---|
授权 | 字符串 | 必需。 Azure AD 访问令牌的格式为 Bearertoken<>。 |
请求参数
名称 | Type | 说明 |
---|---|---|
applicationId | 字符串 | 必需。 要为其更新提交的应用的应用商店 ID。 有关应用商店 ID 的详细信息,请参阅查看应用标识详细信息。 |
submissionId | string | 必需。 要更新的提交的 ID。 此 ID 包含在创建应用提交请求的响应数据中。 对于在合作伙伴中心中创建的提交,此 ID 也可以在合作伙伴中心提交页面的 URL 中找到。 |
请求正文
请求正文具有以下参数。
Value | 类型 | 描述 |
---|---|---|
applicationCategory | string | 一个字符串,指定 应用的类别和/或子类别 。 类别和子类别合并为带有下划线“_”字符的单个字符串,例如 BooksAndReference_EReader。 |
定价 | object | 一个对象,其中包含应用的定价信息。 有关详细信息,请参阅 “定价资源 ”部分。 |
可见性 | string | 应用的可见性。 这可以是以下值之一:
|
targetPublishMode | string | 提交的发布模式。 这可以是以下值之一:
|
targetPublishDate | string | 提交的发布日期采用 ISO 8601 格式(如果 targetPublishMode 设为“SpecificDate”)。 |
listings | object | 键和值对字典,其中每个键都是国家/地区代码,每个值都是一个 列表资源 对象,其中包含应用的列表信息。 |
hardwarePreferences | array | 定义应用的硬件首选项的字符串数组。 这可以是以下值之一:
|
automaticBackupEnabled | boolean | 指示 Windows 是否可以将应用的数据包含在 OneDrive 的自动备份中。 有关详细信息,请参阅 应用声明。 |
canInstallOnRemovableMedia | boolean | 指示客户是否可以将应用安装到可移动存储。 有关详细信息,请参阅 应用声明。 |
isGameDvrEnabled | boolean | 指示是否为应用启用游戏 DVR。 |
gamingOptions | object | 一个数组,其中包含一个 游戏选项资源 ,用于定义应用的游戏相关设置。 |
hasExternalInAppProducts | boolean | 指示你的应用是否允许用户在Microsoft应用商店商务系统之外进行购买。 有关详细信息,请参阅 应用声明。 |
meetAccessibilityGuidelines | boolean | 指示应用是否已测试以满足辅助功能准则。 有关详细信息,请参阅 应用声明。 |
notesForCertification | string | 包含 应用的认证 说明。 |
applicationPackages | array | 包含提供提交中关于每个程序包详细信息的对象。 有关详细信息,请参阅 “应用程序包 ”部分。 调用此方法更新应用提交时,请求正文中仅需要这些对象的 fileName、fileStatus、minimumDirectXVersion 和 minimumSystemRam 值。 其他值由合作伙伴中心进行填充。 |
packageDeliveryOptions | object | 包含提交的逐步软件包推出和强制更新设置。 有关详细信息,请参阅软件包传递选项对象部分。 |
enterpriseLicensing | string | 指示应用的企业许可行为的企业许可值之一。 |
allowMicrosftDecideAppAvailabilityToFutureDeviceFamilies | boolean | 指示是否允许 Microsoft使应用可供将来的 Windows 10 和 Windows 11 设备系列使用。 |
allowTargetFutureDeviceFamilies | boolean | 指示你的应用是否允许 面向未来的 Windows 10 和 Windows 11 设备系列。 |
拖车 | array | 一个数组,包含最多 表示应用列表的视频预告片资源的预告片资源 。 |
请求示例
以下示例演示如何更新应用提交。
PUT https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/submissions/1152921504621230023 HTTP/1.1
Authorization: Bearer <your access token>
Content-Type: application/json
{
"applicationCategory": "BooksAndReference_EReader",
"pricing": {
"trialPeriod": "FifteenDays",
"marketSpecificPricings": {},
"sales": [],
"priceId": "Tier2"
},
"visibility": "Public",
"targetPublishMode": "Manual",
"targetPublishDate": "1601-01-01T00:00:00Z",
"listings": {
"en-us": {
"baseListing": {
"copyrightAndTrademarkInfo": "",
"keywords": [
"epub"
],
"licenseTerms": "",
"privacyPolicy": "",
"supportContact": "",
"websiteUrl": "",
"description": "Description",
"features": [
"Free ebook reader"
],
"releaseNotes": "",
"images": [
{
"fileName": "contoso.png",
"fileStatus": "Uploaded",
"id": "1152921504672272757",
"imageType": "Screenshot"
}
],
"recommendedHardware": [],
"title": "Contoso ebook reader"
},
"platformOverrides": {
"Windows81": {
"description": "Ebook reader for Windows 8.1"
}
}
}
},
"hardwarePreferences": [
"Touch"
],
"automaticBackupEnabled": false,
"canInstallOnRemovableMedia": true,
"isGameDvrEnabled": false,
"gamingOptions": [],
"hasExternalInAppProducts": false,
"meetAccessibilityGuidelines": true,
"notesForCertification": "",
"applicationPackages": [
{
"fileName": "contoso_app.appx",
"fileStatus": "PendingUpload",
"minimumDirectXVersion": "None",
"minimumSystemRam": "None"
}
],
"packageDeliveryOptions": {
"packageRollout": {
"isPackageRollout": false,
"packageRolloutPercentage": 0.0,
"packageRolloutStatus": "PackageRolloutNotStarted",
"fallbackSubmissionId": "0"
},
"isMandatoryUpdate": false,
"mandatoryUpdateEffectiveDate": "1601-01-01T00:00:00.0000000Z"
},
"enterpriseLicensing": "Online",
"allowMicrosoftDecideAppAvailabilityToFutureDeviceFamilies": true,
"allowTargetFutureDeviceFamilies": {
"Desktop": false,
"Mobile": true,
"Holographic": true,
"Xbox": false,
"Team": true
},
"trailers": []
}
响应
以下示例演示了成功调用此方法的 JSON 响应正文。 该响应正文包含已更新提交的相关信息。 有关响应正文中这些值的更多详细信息,请参阅应用提交资源。
{
"id": "1152921504621243540",
"applicationCategory": "BooksAndReference_EReader",
"pricing": {
"trialPeriod": "FifteenDays",
"marketSpecificPricings": {},
"sales": [],
"priceId": "Tier2"
},
"visibility": "Public",
"targetPublishMode": "Manual",
"targetPublishDate": "1601-01-01T00:00:00Z",
"listings": {
"en-us": {
"baseListing": {
"copyrightAndTrademarkInfo": "",
"keywords": [
"epub"
],
"licenseTerms": "",
"privacyPolicy": "",
"supportContact": "",
"websiteUrl": "",
"description": "Description",
"features": [
"Free ebook reader"
],
"releaseNotes": "",
"images": [
{
"fileName": "contoso.png",
"fileStatus": "Uploaded",
"id": "1152921504672272757",
"imageType": "Screenshot"
}
],
"recommendedHardware": [],
"title": "Contoso ebook reader"
},
"platformOverrides": {
"Windows81": {
"description": "Ebook reader for Windows 8.1",
}
}
}
},
"hardwarePreferences": [
"Touch"
],
"automaticBackupEnabled": false,
"canInstallOnRemovableMedia": true,
"isGameDvrEnabled": false,
"gamingOptions": [],
"hasExternalInAppProducts": false,
"meetAccessibilityGuidelines": true,
"notesForCertification": "",
"status": "PendingCommit",
"statusDetails": {
"errors": [],
"warnings": [],
"certificationReports": []
},
"fileUploadUrl": "https://productingestionbin1.blob.core.windows.net/ingestion/387a9ea8-a412-43a9-8fb3-a38d03eb483d?sv=2014-02-14&sr=b&sig=sdd12JmoaT6BhvC%2BZUrwRweA%2Fkvj%2BEBCY09C2SZZowg%3D&se=2016-06-17T18:32:26Z&sp=rwl",
"applicationPackages": [
{
"fileName": "contoso_app.appx",
"fileStatus": "PendingUpload",
"id": "1152921504620138797",
"version": "1.0.0.0",
"architecture": "ARM",
"languages": [
"en-US"
],
"capabilities": [
"ID_RESOLUTION_HD720P",
"ID_RESOLUTION_WVGA",
"ID_RESOLUTION_WXGA"
],
"minimumDirectXVersion": "None",
"minimumSystemRam": "None",
"targetDeviceFamilies": [
"Windows.Mobile min version 10.0.10240.0"
]
}
],
"packageDeliveryOptions": {
"packageRollout": {
"isPackageRollout": false,
"packageRolloutPercentage": 0.0,
"packageRolloutStatus": "PackageRolloutNotStarted",
"fallbackSubmissionId": "0"
},
"isMandatoryUpdate": false,
"mandatoryUpdateEffectiveDate": "1601-01-01T00:00:00.0000000Z"
},
"enterpriseLicensing": "Online",
"allowMicrosoftDecideAppAvailabilityToFutureDeviceFamilies": true,
"allowTargetFutureDeviceFamilies": {
"Desktop": false,
"Mobile": true,
"Holographic": true,
"Xbox": false,
"Team": true
},
"friendlyName": "Submission 2",
"trailers": []
}
错误代码
如果无法成功完成请求,该响应中会包含以下 HTTP 错误代码之一。
错误代码 | 说明 |
---|---|
400 | 由于请求无效,无法更新提交。 |
409 | 由于应用的当前状态,或者应用使用的合作伙伴中心功能当前不受 Microsoft Store 提交 API 支持,无法更新提交。 |