Finalizar a distribuição para um envio de versão de pré-lançamentoFinalize the rollout for a flight submission

Use esse método na API de envio da Microsoft Store a fim de finalizar a distribuição de pacote para o envio de um pacote de pré-lançamento.Use this method in the Microsoft Store submission API to finalize the package rollout for a package flight submission. Para obter mais informações sobre o processo de criação de um envio de pacote de pré-lançamento usando a API de envio da Microsoft Store, consulte Gerenciar envios do pacote de pré-lançamento.For more information about the process of process of creating a package flight submission by using the Microsoft Store submission API, see Manage package flight submissions.

Pré-requisitosPrerequisites

Para usar este método, primeiro você precisa do seguinte:To use this method, you need to first do the following:

  • Se você não tiver feito isso, conclua todos os pré-requisitos para a API de envio da Microsoft Store.If you have not done so already, complete all the prerequisites for the Microsoft Store submission API.
  • Obtenha um token de acesso do Azure AD a ser usado no cabeçalho da solicitação para este método.Obtain an Azure AD access token to use in the request header for this method. Após obter um token de acesso, você tem 60 minutos para usá-lo antes dele expirar.After you obtain an access token, you have 60 minutes to use it before it expires. Depois que o token expirar, você poderá obter um novo.After the token expires, you can obtain a new one.
  • Criar um envio para um aplicativo no Partner Center.Create a submission for an app in Partner Center. Você pode fazer isso no Partner Center ou pode fazer isso usando o método criar um envio de aplicativo .You can do this in Partner Center, or you can do this by using the create an app submission method.
  • Habilite uma distribuição de pacote gradual para o envio.Enable a gradual package rollout for the submission. Você pode fazer isso no Partner Centerou pode fazer isso usando a API de envio Microsoft Store.You can do this in Partner Center, or you can do this by using the Microsoft Store submission API.

SolicitaçãoRequest

Esse método tem a seguinte sintaxe.This method has the following syntax. Veja as seções a seguir para obter exemplos de uso e descrições dos parâmetros do cabeçalho e da solicitação.See the following sections for usage examples and descriptions of the header and request parameters.

MétodoMethod URI da solicitaçãoRequest URI
POSTPOST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/flights/{flightId}/submissions/{submissionId}/finalizepackagerollout

Cabeçalho da solicitaçãoRequest header

CabeçalhoHeader TipoType DescriçãoDescription
AutorizaçãoAuthorization stringstring Obrigatórios.Required. O token de acesso do Azure AD no formulário Bearer <token>.The Azure AD access token in the form Bearer <token>.

Parâmetros da solicitaçãoRequest parameters

NomeName TipoType DescriçãoDescription
applicationIdapplicationId stringstring Obrigatórios.Required. A ID da Loja do aplicativo que contém o envio do pacote de pré-lançamento com a distribuição de pacote que você deseja finalizar.The Store ID of the app that contains the package flight submission with the package rollout you want to finalize. Para saber mais informações sobre a ID da Loja, consulte Exibir detalhes de identidade de aplicativo.For more information about the Store ID, see View app identity details.
flightIdflightId stringstring Obrigatórios.Required. A ID do pacote de pré-lançamento que contém o envio com a distribuição de pacote que você deseja finalizar.The ID of the package flight that contains the submission with the package rollout you want to finalize. Essa ID está disponível nos dados de resposta de solicitações para criar um pacote de pré-lançamento e obter pacotes de pré-lançamento para um aplicativo.This ID is available in the response data for requests to create a package flight and get package flights for an app. Para um vôo criado no Partner Center, essa ID também está disponível na URL da página de vôo no Partner Center.For a flight that was created in Partner Center , this ID is also available in the URL for the flight page in Partner Center.
submissionIdsubmissionId stringstring Obrigatórios.Required. A ID do envio com a distribuição de pacote que você deseja finalizar.The ID of the submission with the package rollout you want to finalize. Esse ID está disponível nos dados de resposta para solicitações para criar um envio de pacote de pré-lançamento.This ID is available in the response data for requests to create a package flight submission. Para um envio criado no Partner Center, essa ID também está disponível na URL da página de envio no Partner Center.For a submission that was created in Partner Center, this ID is also available in the URL for the submission page in Partner Center.

Corpo da solicitaçãoRequest body

Não forneça um corpo da solicitação para esse método.Do not provide a request body for this method.

Exemplo de solicitaçãoRequest example

O exemplo a seguir demonstra como finalizar a distribuição de pacote para um envio do pacote de pré-lançamento.The following example demonstrates how to finalize the package rollout for a package flight submission.

POST https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/flights/43e448df-97c9-4a43-a0bc-2a445e736bcd/submissions/1152921504621243680/finalizepackagerollout HTTP/1.1
Authorization: Bearer <your access token>

RespostaResponse

O exemplo a seguir demonstra o corpo da resposta JSON para uma chamada bem-sucedida para esse método.The following example demonstrates the JSON response body for a successful call to this method. Para obter mais detalhes sobre os valores no corpo da resposta, consulte Recurso da distribuição de pacote.For more details about the values in the response body, see Package rollout resource.

{
    "isPackageRollout": true,
    "packageRolloutPercentage": 100.0,
    "packageRolloutStatus": "PackageRolloutComplete",
    "fallbackSubmissionId": "1212922684621243058"
}

Códigos do ErroError codes

Se não for possível concluir a solicitação, a resposta conterá um dos seguintes códigos de erro HTTP.If the request cannot be successfully completed, the response will contain one of the following HTTP error codes.

Código do erroError code DescriçãoDescription
404404 O envio do pacote de pré-lançamento não foi encontrado.The package flight submission could not be found.
409409 Este código indica um dos seguintes erros:This code indicates one of the following errors: