Criar um complementoCreate an add-on

Use esse método na API de envio de Microsoft Store para criar um complemento (também conhecido como produto no aplicativo ou IAP da) para um aplicativo que está registrado em sua conta do Partner Center.Use this method in the Microsoft Store submission API to create an add-on (also known as in-app product or IAP) for an app that is registered to your Partner Center account.

Observação

Este método cria um complemento sem nenhum envio.This method creates an add-on without any submissions. Para criar um envio para um complemento, veja os métodos em Gerenciar envios de complemento.To create a submission for an add-on, see the methods in Manage add-on submissions.

Pré-requisitosPrerequisites

Para usar este método, primeiro você precisa do seguinte:To use this method, you need to first do the following:

  • Se você não tiver feito isso, conclua todos os pré-requisitos para a API de envio da Microsoft Store.If you have not done so already, complete all the prerequisites for the Microsoft Store submission API.
  • Obtenha um token de acesso do Azure AD a ser usado no cabeçalho da solicitação para este método.Obtain an Azure AD access token to use in the request header for this method. Após obter um token de acesso, você tem 60 minutos para usá-lo antes dele expirar.After you obtain an access token, you have 60 minutes to use it before it expires. Depois que o token expirar, você poderá obter um novo.After the token expires, you can obtain a new one.

SolicitaçãoRequest

Esse método tem a seguinte sintaxe.This method has the following syntax. Veja as seções a seguir para obter exemplos de uso e descrições do corpo da solicitação e do cabeçalho.See the following sections for usage examples and descriptions of the header and request body.

MétodoMethod URI da solicitaçãoRequest URI
POSTPOST https://manage.devcenter.microsoft.com/v1.0/my/inappproducts

Cabeçalho da solicitaçãoRequest header

CabeçalhoHeader TipoType DescriçãoDescription
AutorizaçãoAuthorization stringstring Obrigatórios.Required. O token de acesso do Azure AD no formulário Bearer <token>.The Azure AD access token in the form Bearer <token>.

Corpo da solicitaçãoRequest body

O corpo da solicitação tem os parâmetros a seguir.The request body has the following parameters.

ParâmetroParameter TipoType DescriçãoDescription ObrigatórioRequired
applicationIdsapplicationIds matrizarray Uma matriz que contém a ID da Loja do aplicativo ao qual esse complemento está associado.An array that contains the Store ID of the app that this add-on is associated with. Essa matriz é compatível com apenas um item.Only one item is supported in this array. SimYes
productIdproductId stringstring A ID do produto do complemento.The product ID of the add-on. Este é um identificador que pode ser usado no código para fazer referência ao complemento.This is an identifier that can use in code to refer to the add-on. Para obter mais informações, consulte Definir seu tipo de produto e a ID do produto.For more information, see Set your product type and product ID. SimYes
productTypeproductType stringstring O tipo de produto do complemento.The product type of the add-on. Há suporte para os seguintes valores: Durável e Consumíveis.The following values are supported: Durable and Consumable. SimYes

Exemplo de solicitaçãoRequest example

O exemplo a seguir demonstra como criar um novo complemento consumível para um aplicativo.The following example demonstrates how to create a new consumable add-on for an app.

POST https://manage.devcenter.microsoft.com/v1.0/my/inappproducts HTTP/1.1
Authorization: Bearer eyJ0eXAiOiJKV1Q...
Content-Type: application/json
{
    "applicationIds": [  "9NBLGGH4R315"  ],
    "productId": "my-new-add-on",
    "productType": "Consumable",
}

RespostaResponse

O exemplo a seguir demonstra o corpo da resposta JSON para uma chamada bem-sucedida para esse método.The following example demonstrates the JSON response body for a successful call to this method. Para obter mais detalhes sobre os valores no corpo da resposta, veja recurso do complemento.For more details about the values in the response body, see add-on resource.

{
  "applications": {
    "value": [
      {
        "id": "9NBLGGH4R315",
        "resourceLocation": "applications/9NBLGGH4R315"
      }
    ],
    "totalCount": 1
  },
  "id": "9NBLGGH4TNMP",
  "productId": "my-new-add-on",
  "productType": "Consumable",
}

Códigos do ErroError codes

Se não for possível concluir a solicitação, a resposta conterá um dos seguintes códigos de erro HTTP.If the request cannot be successfully completed, the response will contain one of the following HTTP error codes.

Código do erroError code DescriçãoDescription
400400 A solicitação é inválida.The request is invalid.
409409 O complemento não pôde ser criado devido a seu estado atual, ou o complemento usa um recurso do centro de parceria que atualmente não tem suporte pela API de envio de Microsoft Store.The add-on could not be created because of its current state, or the add-on uses a Partner Center feature that is currently not supported by the Microsoft Store submission API.