Compartilhar via

Obter informações de distribuição para um envio de aplicativo

  • Artigo

Use esse método na API de envio da Microsoft Store para obter informações de distribuição de pacote para um envio de pacote de pré-lançamento. Para obter mais informações sobre o 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 dos parâmetros de cabeçalho e solicitação.

Método URI da solicitação
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/packagerollout

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 que contém o envio com as informações de distribuição do pacote que você deseja obter. 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 com as informações de distribuição do pacote que você deseja obter. 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

Não forneça um corpo de solicitação para esse método.

Exemplo de solicitação

O exemplo a seguir demonstra como obter as informações de distribuição do pacote para um envio de aplicativo.

GET https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/submissions/1152921504621243649/packagerollout HTTP/1.1
Authorization: Bearer <your access token>

Resposta

O exemplo a seguir demonstra o corpo da resposta JSON para uma chamada bem-sucedida para esse método para um envio de aplicativo com a distribuição gradual do pacote habilitada. Para obter mais detalhes sobre os valores no corpo da resposta, consulte Recurso de distribuição do pacote.

{
    "isPackageRollout": true,
    "packageRolloutPercentage": 25.0,
    "packageRolloutStatus": "PackageRolloutInProgress",
    "fallbackSubmissionId": "1212922684621243058"
}

Se o envio do aplicativo não tiver a distribuição gradual do pacote habilitada, o corpo da resposta a seguir será retornado.

{
    "isPackageRollout": false,
    "packageRolloutPercentage": 0.0,
    "packageRolloutStatus": "PackageRolloutNotStarted",
    "fallbackSubmissionId": "0"
}

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 Descrição
404 Não foi possível encontrar o pedido.
409 O envio não pertence ao aplicativo especificado ou o aplicativo usa um recurso do Partner Center que atualmente não tem suporte da API de envio da Microsoft Store.