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

  • Artigo

Use esse método na API de envio da Microsoft Store a fim de obter as informações da distribuição de pacote para o envio de um 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 do seguinte:

  • Se você 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 este 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 criar um envio de aplicativo .

Solicitação

Esse método tem a seguinte sintaxe. Veja as seções a seguir para obter exemplos de uso e descrições dos parâmetros do cabeçalho e da 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

parâmetro Tipo Descrição
Autorização string Obrigatórios. O token de acesso Azure AD notoken> de portador< de formulário.

Parâmetros da solicitação

Nome Tipo Descrição
applicationId string Obrigatórios. A ID da Loja do aplicativo que contém o envio com as informações da distribuição de pacote que você deseja obter. Para saber mais informações sobre a ID da Loja, consulte Exibir detalhes de identidade de aplicativo.
submissionId string Obrigatórios. A ID do envio com as informações da distribuição de pacote que você deseja obter. Esse 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 da solicitação para esse método.

Exemplo de solicitação

O exemplo a seguir demonstra como obter as informações da distribuição de 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 de pacote gradual habilitada. Para obter mais detalhes sobre os valores no corpo da resposta, consulte Recurso da distribuição de pacote.

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

Se o envio de aplicativo não tiver distribuição de pacote gradual habilitada, o seguinte corpo de resposta será retornado.

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

Códigos do Erro

Se não for possível concluir a solicitação, a resposta conterá um dos seguintes códigos de erro HTTP.

Código do erro Descrição
404 O envio não foi encontrado.
409 O envio não pertence ao aplicativo especificado ou o aplicativo usa um recurso do Partner Center que atualmente não é compatível com a API de envio da Microsoft Store.