Compartilhar via


Obter um complemento

Use esse método na API de envio da Microsoft Store para recuperar informações sobre um complemento (também conhecido como produto no aplicativo ou IAP) para 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/inappproducts/{inAppProductId}

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
id string Obrigatória. A ID da Loja do complemento a ser recuperado. A ID da Loja está disponível 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 recuperar informações sobre um complemento.

GET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/9NBLGGH4TNMP 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 obter mais detalhes sobre os valores no corpo da resposta, consulte recurso complementar.

{
  "applications": {
    "value": [
      {
        "id": "9NBLGGH4R315",
        "resourceLocation": "applications/9NBLGGH4R315"
      }
    ],
    "totalCount": 1
  },
  "id": "9NBLGGH4TNMP",
  "productId": "Test-add-on",
  "productType": "Durable",
  "pendingInAppProductSubmission": {
    "id": "1152921504621243619",
    "resourceLocation": "inappproducts/9NBLGGH4TNMP/submissions/1152921504621243619"
  },
  "lastPublishedInAppProductSubmission": {
    "id": "1152921504621243705",
    "resourceLocation": "inappproducts/9NBLGGH4TNMP/submissions/1152921504621243705"
  }
}

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 complemento especificado.
409 O complemento usa um recurso do Partner Center que atualmente não é compatível com a API de envio da Microsoft Store.