Compartilhar via

Gerenciar complementos

  • Artigo

Use os métodos a seguir 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 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 envios para complementos, consulte os métodos em Gerenciar envios de complementos.

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

Pré-requisitos

Se você ainda não tiver feito isso, conclua 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 de 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 possui os seguintes valores.

Valor Type Descrição
de dimensionamento da Web matriz Uma matriz que contém um recurso de aplicativo que representa o aplicativo ao qual esse complemento está associado. Há suporte para apenas um item nessa matriz.
ID string A ID da Loja do complemento. Esse valor é fornecido pela Loja. Um exemplo de ID da Loja é 9NBLGGH4TNMP.
productId string A ID do produto do complemento. Essa é a ID fornecida pelo desenvolvedor quando o complemento foi criado. Para obter mais informações, consulte Definir o tipo de produto e a ID do produto.
productType string O tipo de produto do complemento. Os seguintes valores são suportados: Durável e Consumível.
lastPublishedInAppProductSubmission objeto Um recurso de envio que fornece informações sobre o último envio publicado para o complemento.
pendingInAppProductSubmission objeto Um recurso de envio que fornece informações sobre o envio pendente atual para o complemento.

Recurso de aplicativo

Esse 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 possui os seguintes valores.

Valor Type Descrição
value objeto Um objeto que contém os seguintes valores:
  • id. A ID da Loja do aplicativo. Para obter mais informações sobre a ID da Loja, consulte Exibir detalhes da identidade do aplicativo.
  • resourceLocation. Um caminho relativo que você pode acrescentar ao URI de solicitação base https://manage.devcenter.microsoft.com/v1.0/my/ para recuperar os dados completos do aplicativo.
contagem total int O número de objetos de aplicativo na matriz de aplicativos do corpo da resposta.

Recurso de envio

Este recurso fornece informações sobre um envio para um complemento. O exemplo a seguir demonstra o formato desse recurso.

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

Este recurso possui os seguintes valores.

Valor Type Descrição
id string A ID do envio.
resourceLocation string Um caminho relativo que você pode acrescentar ao URI de solicitação base https://manage.devcenter.microsoft.com/v1.0/my/ para recuperar os dados completos do envio.