Compartilhar via

Obter complementos para um app

  • Artigo

Use esse método na API de envio da Microsoft Store para listar os complementos de um aplicativo registrado em sua conta do Partner Center.

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.

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
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/listinappproducts

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 Obrigatório
applicationId string A ID da Loja do aplicativo para o qual você deseja recuperar os complementos. Para obter mais informações sobre a ID da Loja, consulte Exibir detalhes da identidade do aplicativo. Sim
top int O número de itens a serem retornados na solicitação (ou seja, o número de complementos a serem retornados). Se o aplicativo tiver mais complementos do que o valor especificado na consulta, o corpo da resposta incluirá um caminho de URI relativo que você pode acrescentar ao URI do método para solicitar a próxima página de dados. Não
skip int O número de itens a serem ignorados na consulta antes de retornar os itens restantes. Use esse parâmetro para percorrer os conjuntos de dados. Por exemplo, top=10 e skip=0 recuperam os itens de 1 a 10, top=10 e skip=10 recuperam os itens de 11 a 20 e assim por diante. Não

Corpo da solicitação

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

Exemplos de solicitação

O exemplo a seguir demonstra como listar todos os complementos de um aplicativo.

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

O exemplo a seguir demonstra como listar os primeiros 10 complementos de um aplicativo.

GET https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/listinappproducts?top=10 HTTP/1.1
Authorization: Bearer <your access token>

Resposta

O exemplo a seguir demonstra o corpo da resposta JSON retornado por uma solicitação bem-sucedida para os primeiros 10 complementos de um aplicativo com 53 complementos no total. Para resumir, este exemplo mostra apenas os dados dos três primeiros complementos retornados pela solicitação. Para obter mais detalhes sobre os valores no corpo da resposta, consulte a seção a seguir.

{
  "@nextLink": "applications/9NBLGGH4R315/listinappproducts/?skip=10&top=10",
  "value": [
    {
      "inAppProductId": "9NBLGGH4TNMP"
    },
    {
      "inAppProductId": "9NBLGGH4TNMN"
    },
    {
      "inAppProductId": "9NBLGGH4TNNR"
    },
    // Next 7 add-ons  are omitted for brevity ...
  ],
  "totalCount": 53
}

Corpo da resposta

Valor Type Descrição
@nextLink string Se houver páginas adicionais de dados, essa cadeia de caracteres conterá um caminho relativo que você pode acrescentar ao URI de solicitação base https://manage.devcenter.microsoft.com/v1.0/my/ para solicitar a próxima página de dados. Por exemplo, se o parâmetro top do corpo da solicitação inicial estiver definido como 10, mas houver 50 complementos para o aplicativo, o corpo da resposta incluirá um @nextLink valor de applications/{applicationid}/listinappproducts/?skip=10&top=10, que indica que você pode chamar https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationid}/listinappproducts/?skip=10&top=10 para solicitar os próximos 10 complementos.
value matriz Uma matriz de objetos que lista a ID da Loja de cada complemento para o aplicativo especificado. Para obter mais informações sobre os dados em cada objeto, consulte recurso de complemento.
contagem total int O número total de linhas no resultado de dados para a consulta (ou seja, o número total de complementos para o aplicativo especificado).

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 Nenhum complemento foi encontrado.
409 Os complementos usam recursos do Partner Center que atualmente não têm suporte da API de envio da Microsoft Store.