Atualizar um envio de aplicativo
Use esse método na API de envio da Microsoft Store para atualizar um envio de aplicativo existente. Depois de atualizar com êxito um envio usando esse método, você deve confirmar o envio para ingestão e publicação.
Para obter mais informações sobre como esse método se encaixa no processo de criação de um envio de aplicativo usando a API de envio da Microsoft Store, consulte Gerenciar envios de aplicativo.
Pré-requisitos
Para usar este método, primeiro você precisa fazer o seguinte:
- Se você ainda não tiver feito isso, conclua todos os pré-requisitos para a API de envio da Microsoft Store.
- Obtenha um token de acesso do Azure AD a ser usado no cabeçalho da solicitação para esse método. Após obter um token de acesso, você tem 60 minutos para usá-lo antes dele expirar. Depois que o token expirar, você poderá obter um novo.
- Crie um envio para um de seus aplicativos. Você pode fazer isso no Partner Center ou pode fazer isso usando o método de criação de um envio de aplicativo.
Solicitar
Esse método tem a seguinte sintaxe. Consulte as seções a seguir para obter exemplos de uso e descrições do cabeçalho e do corpo da solicitação.
Método | URI da solicitação |
---|---|
PUT | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} |
Cabeçalho da solicitação
Cabeçalho | Tipo | Descrição |
---|---|---|
Autorização | string | Obrigatório. O token de acesso do Azure AD no Token<de portador> do formulário. |
Parâmetros da solicitação
Nome | Tipo | Descrição |
---|---|---|
applicationId | string | Obrigatória. A ID da Loja do aplicativo para o qual você deseja atualizar um envio. Para obter mais informações sobre a ID da Loja, consulte Exibir detalhes da identidade do aplicativo. |
submissionId | string | Obrigatória. A ID do envio a ser atualizado. Essa ID está disponível nos dados de resposta para solicitações para criar um envio de aplicativo. Para um envio criado no Partner Center, essa ID também está disponível na URL da página de envio no Partner Center. |
Corpo da solicitação
O corpo da solicitação tem os seguintes parâmetros.
Valor | Type | Descrição |
---|---|---|
categoria de aplicação | string | Uma cadeia de caracteres que especifica a categoria e/ou subcategoria do seu aplicativo. Categorias e subcategorias são combinadas em uma única cadeia de caracteres com o caractere sublinhado '_', como BooksAndReference_EReader. |
preços | objeto | Um objeto que contém informações de preços para o aplicativo. Para obter mais informações, consulte a seção Recurso de preços. |
visibility | string | A visibilidade do aplicativo. Esse valor pode ser um dos seguintes:
|
targetPublishMode | string | O modo de publicação para o envio. Esse valor pode ser um dos seguintes:
|
targetPublishDate | string | A data de publicação para o envio no formato ISO 8601, se o targetPublishMode estiver definido como SpecificDate. |
listagens | objeto | Um dicionário de pares de chave e valor, em que cada chave é um código de país e cada valor é um objeto de recurso Listing que contém informações de listagem para o aplicativo. |
hardwarePreferências | matriz | Uma matriz de cadeias de caracteres que definem as preferências de hardware do seu aplicativo. Esse valor pode ser um dos seguintes:
|
automaticBackupEnabled | boolean | Indica se o Windows pode incluir os dados do seu aplicativo em backups automáticos no OneDrive. Para obter mais informações, consulte Declarações de aplicativo. |
canInstallOnRemovableMedia | boolean | Indica se os clientes podem instalar seu aplicativo no armazenamento removível. Para obter mais informações, consulte Declarações de aplicativo. |
isGameDvrEnabled | boolean | Indica se o DVR do jogo está habilitado para o aplicativo. |
opções de jogos | objeto | Uma matriz que contém um recurso de opções de jogos que define as configurações relacionadas ao jogo para o aplicativo. |
temExternalInAppProducts | boolean | Indica se seu aplicativo permite que os usuários façam compras fora do sistema de comércio da Microsoft Store. Para obter mais informações, consulte Declarações de aplicativo. |
meetAccessibilityGuidelines | boolean | Indica se seu aplicativo foi testado para atender às diretrizes de acessibilidade. Para obter mais informações, consulte Declarações de aplicativo. |
notesForCertification | string | Contém notas para certificação do seu aplicativo. |
Pacotes de aplicativos | matriz | Contém objetos que fornecem detalhes sobre cada pacote no envio. Para obter mais informações, consulte a seção Pacote de aplicativos. Ao chamar esse método para atualizar um envio de aplicativo, somente os valores fileName, fileStatus, minimumDirectXVersion e minimumSystemRam desses objetos são necessários no corpo da solicitação. Os outros valores são preenchidos pelo Partner Center. |
packageDeliveryOptions | objeto | Contém a distribuição gradual do pacote e as configurações de atualização obrigatórias para o envio. Para obter mais informações, consulte Objeto de opções de entrega de pacote. |
enterpriseLicensing | string | Um dos valores de valores de licenciamento corporativo que indicam o comportamento de licenciamento corporativo do aplicativo. |
allowMicrosftDecideAppAvailabilityToFutureDeviceFamilies | boolean | Indica se a Microsoft tem permissão para disponibilizar o aplicativo para futuras famílias de dispositivos Windows 10 e Windows 11. |
allowTargetFutureDeviceFamilies | boolean | Indica se o aplicativo tem permissão para direcionar futuras famílias de dispositivos Windows 10 e Windows 11. |
Reboques | matriz | Uma matriz que contém até recursos de trailer que representam trailers de vídeo para a listagem do aplicativo. |
Exemplo de solicitação
O exemplo a seguir demonstra como atualizar um envio de aplicativo.
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": []
}
Resposta
O exemplo a seguir demonstra o corpo da resposta JSON para uma chamada bem-sucedida para esse método. O corpo da resposta contém informações sobre o envio atualizado. Para obter mais detalhes sobre os valores no corpo da resposta, consulte Recurso de envio de aplicativo.
{
"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": []
}
Códigos do Erro
Se a solicitação não puder ser concluída com êxito, a resposta conterá um dos seguintes códigos de erro HTTP.
Código do erro | Description |
---|---|
400 | O envio não pôde ser atualizado porque a solicitação é inválida. |
409 | O envio não pôde ser atualizado devido ao estado atual do aplicativo ou o aplicativo usa um recurso do Partner Center que atualmente não é compatível com a API de envio da Microsoft Store. |