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 IAP ou produto no aplicativo) para um aplicativo registrado em sua conta do Partner Center.

Pré-requisitos

Para usar esse método, primeiro você precisa fazer o seguinte:

  • Se você ainda não fez 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. Depois de obter um token de acesso, você terá 60 minutos para usá-lo antes que ele expire. Depois que o token expirar, você poderá obter um novo.

Solicitação

Esse método tem a sintaxe a seguir. Consulte as seções a seguir para obter exemplos de uso e descrições do corpo do cabeçalho e da solicitação.

Método URI de solicitação
OBTER https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{inAppProductId}

Cabeçalho da solicitação

Cabeçalho Tipo Descrição
Autorização corda Obrigatório O token de acesso do Azure AD no formato Bearer<token>.

Parâmetros de solicitação

Nome Tipo Descrição
id corda Obrigatório O ID da loja do add-on para recuperação. O ID da Loja está disponível na Central de Parceiros.

Corpo da solicitação

Não forneça um corpo de solicitação para este 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 de uma chamada bem-sucedida a este método. Para obter mais detalhes sobre os valores no corpo da resposta, consulte o 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 de 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 tem suporte da API de envio da Microsoft Store.