API de ingestão de produtos para recipientes

Artigo
04/29/2024

A API de ingestão de produtos é uma API modernizada que unifica todas as APIs de envio existentes em todos os produtos de mercado comercial. Consulte a API de ingestão de produtos para obter detalhes sobre como começar.

Este artigo fornece orientação sobre como usar as APIs especificamente para contêineres.

Recuperar configurações de recursos existentes

Recupere todos os recursos de um produto específico em uma única chamada de API.

GET resource-tree/<product-durableID>?$version=<schema-version>

Você pode recuperar todas as configurações de recursos dentro de um produto específico usando o tipo de recurso "árvore de recursos" junto com a ID durável do produto. A versão do esquema fornecida é usada como a versão máxima suportada para cada um dos recursos aplicáveis do produto solicitado.

Nota

Se você não souber a ID durável do produto, poderá recuperar o recurso do produto primeiro usando a ID externa do produto e executando. Para saber mais, consulte API do produto: método 1: árvore de recursos.

Exemplo de chamada GET:

OBTENHA https://graph.microsoft.com/rp/product-ingestion/resource-tree/product/12345678-abcd-efgh-1234-12345678901?targetType=" pré-visualização"&$version=2022-03-01-pré-visualização5

Exemplo de resposta:

{
  "$schema": "https://schema.mp.microsoft.com/schema/resource-tree/2022-03-01-preview2",
  "root": "product/12345678-abcd-efgh-1234-12345678901",
  "target": {
    "targetType": "preview"
  },
  "resources": [
  { 
    "$schema": "https://schema.mp.microsoft.com/schema/product/2022-03-01-preview3",
    "id": "product/12345678-abcd-efgh-1234-12345678901",
    "identity": {
      "externalID": "product_external_id_example"
    },
    "type": "azureContainer",
    "alias": "product_example"
  },
  { 
    "$schema": "https://schema.mp.microsoft.com/schema/commercial-marketplace-setup/2022-03-01-preview2",
    "id": "commercial-marketplace-setup/12345678-abcd-efgh-1234-12345678901",
    "product": "product/12345678-abcd-efgh-1234-12345678901",
    "sellThroughMicrosoft": true
  },
  {
    "$schema": "https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2",
    "id": "plan/12345678-abcd-efgh-1234-12345678901/98756328-04e9-55ae-9403-52b6c971a956
  ...
  }, 
     // The response would include all existing resources within this product.
  {
     ...
  }]
}

Sincronizar audiências privadas

Para um produto ao vivo, as atualizações para audiências privadas no rascunho, visualização e ambientes ao vivo podem ser realizadas ao mesmo tempo sem a necessidade de uma publicação. Você pode sincronizar o público privado usando o recurso "preço-e-disponibilidade-atualização-audiências-privadas" especificando quais públicos você deseja adicionar ou remover de um plano específico. Isso sincronizará os ambientes de rascunho, visualização e ao vivo para ter os mesmos valores de audiência privada. Você não precisa fornecer o recurso de envio ao sincronizar a audiência privada.

Para editar as audiências de rascunho, use o recurso "plano de preço e disponibilidade" e a propriedade "privateAudiences". Isso precisará passar pelo fluxo de publicação regular para que os valores sejam definidos na visualização e ao vivo.

Importante

Se o seu produto suportar mais de um tipo de identificador para configurar a audiência privada (por exemplo, IDs de locatário e IDs de assinatura), você deverá executar uma publicação completa se fornecer um novo tipo de identificador pela primeira vez. Neste caso, não é possível sincronizar a audiência privada.

Exemplo de solicitação para sincronizar a configuração de audiência privada: