Partilhar via


Gerenciar complementos

Use os seguintes métodos na API de envio da Microsoft Store para gerenciar complementos para seus aplicativos. Para obter uma introdução à API de envio da Microsoft Store, incluindo os pré-requisitos para usar a API, consulte Criar e gerenciar envios usando os serviços da Microsoft Store.

Esses métodos só podem ser usados para obter, criar ou excluir complementos. Para criar submissões para complementos, consulte os métodos em Gerir submissões de complementos.

Método URI Descrição
OBTER https://manage.devcenter.microsoft.com/v1.0/my/inappproducts Obtenha todos os complementos para seus aplicativos
OBTER https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{inAppProductId} Obter um complemento específico
PUBLICAR https://manage.devcenter.microsoft.com/v1.0/my/inappproducts Criar um complemento
SUPRIMIR https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{inAppProductId} Excluir um complemento

Pré-requisitos

Se você ainda não tiver feito isso, preencha todos os pré-requisitos para a API de envio da Microsoft Store antes de tentar usar qualquer um desses métodos.

Recursos de dados

Os métodos da API de envio da Microsoft Store para gerenciar complementos usam os seguintes recursos de dados JSON.

Recurso complementar

Este recurso descreve um complemento.

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

Este recurso tem os seguintes valores.

Valor Tipo Descrição
Aplicações matriz Uma matriz que contém um recurso de aplicativo , que representa o aplicativo com o qual este complemento está associado. Apenas um item é suportado nesta matriz.
ID corda O ID da Loja do complemento. Este valor é fornecido pela Loja. Um exemplo de ID da Loja é 9NBLGGH4TNMP.
productId corda A ID do produto do complemento. Este é o ID que foi fornecido pelo desenvolvedor quando o complemento foi criado. Para obter mais informações, consulte Definir o tipo de produto e a ID do produto.
tipoDeProduto corda O tipo de produto do complemento. Os seguintes valores são suportados: Durable e Consumable.
últimaPublicaçãoNaSubmissãoDoProdutoApp objeto Um recurso de envio que fornece informações sobre o último envio publicado para a extensão.
PendenteSubmissãoDeProdutoInApp objeto Um recurso de submissão de que fornece informações sobre a submissão pendente atual para o complemento.

Recurso de aplicação

Este recurso descreve o aplicativo ao qual um complemento está associado. O exemplo a seguir demonstra o formato desse recurso.

{
  "applications": {
    "value": [
      {
        "id": "9NBLGGH4R315",
        "resourceLocation": "applications/9NBLGGH4R315"
      }
    ],
    "totalCount": 1
  },
}

Este recurso tem os seguintes valores.

Valor Tipo Descrição
valor objeto Um objeto que contém os seguintes valores:
  • id. O ID da loja da app. Para obter mais informações sobre a ID da Loja, consulte Exibir detalhes de identidade do aplicativo.
  • resourceLocation. Um caminho de acesso relativo que se pode anexar ao URI de solicitação base https://manage.devcenter.microsoft.com/v1.0/my/ para recuperar os dados completos da aplicação.
contagemTotal Int O número de objetos de aplicativo na matriz dos aplicativos do corpo da resposta.

Recurso de submissão

Este recurso proporciona informações sobre uma submissão para um complemento. O exemplo a seguir demonstra o formato desse recurso.

{
  "pendingInAppProductSubmission": {
    "id": "1152921504621243619",
    "resourceLocation": "inappproducts/9NBLGGH4TNMP/submissions/1152921504621243619"
  },
}

Este recurso tem os seguintes valores.

Valor Tipo Descrição
ID corda O identificador do envio.
resourceLocalização corda Um caminho relativo que poderá acrescentar à URI de pedido base https://manage.devcenter.microsoft.com/v1.0/my/ para recuperar os dados completos da submissão.