> ## Documentation Index
> Fetch the complete documentation index at: https://docs.topsort.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Marcas patrocinadas

> Aprenda como usar a API de leilões de Marcas Patrocinadas para criar leilões de promoções de marca.

A API de Leilões de Marcas Patrocinadas permite executar leilões para promover marcas usando assets, texto e produtos associados.

## Antes de Começar

Para usar a API de Leilões de Marcas Patrocinadas, certifique-se de ter concluído o seguinte:

1. [Obter uma API key](/en/api-reference/authentication#obtaining-an-api-key) para autenticação.
2. [Criar várias campanhas](/en/knowledge-base/ad-platform/campaign-creation/), para ter lances disponíveis para os leilões.

## Solicitação

O endpoint `/auctions/sponsored-brand` permite executar leilões para posicionamentos de marcas patrocinadas.

Para a especificação completa deste endpoint, consulte a [documentação da API](/en/api-reference/auctions/create-sponsored-brand-auctions).

### Exemplo de Solicitação

```json theme={null}
{
  "auctions": [
    {
      "winners": 2,
      "placementId": "some-placement",
      "triggers": {
        "products": {
          "ids": ["1", "8"]
        }
      }
    }
  ]
}
```

#### Campos Principais:

* **`auctions`**: Um array contendo objetos de leilão.
* **`winners`**: O número máximo de vencedores para o leilão.
* **`placementId`**: O ID do posicionamento onde o anúncio aparecerá.
* **`triggers.products.ids`**: Um array de IDs de produtos associados ao leilão.

***

## Resposta

<Warning>
  **Não armazene em cache esta resposta** ou seus resultados. Os leilões devem permanecer únicos por visualização de página para garantir o funcionamento adequado.

  O armazenamento em cache pode resultar em resultados repetidos para vários usuários ou sessões.
</Warning>

Se não ocorrerem [erros de solicitação](https://topsort.mintlify.app/api-reference/errors), o endpoint retorna os resultados do leilão.

### Resposta Com Vencedores

Exemplo de resposta quando vencedores são encontrados:

```json theme={null}
{
  "results": [
    {
      "winners": [
        {
          "rank": 1,
          "resolvedBidId": "ChAGc-G66Wt7LKQEOcW8VBdIEhABjz_zDXx7db-ZYpxiwJ3DGhABjr4Lt_J0_a7Xv_uIfyOXIgUKATEQATDrrg8",
          "productId": "1",
          "title": "Brand Example Promo 1",
          "assets": [
            {
              "url": "https://assets.hosted.topsort.com/5bcccb92e5eaaa73ce9fcc545e944865bf70e9b60e5a048979769282450343c4/example-banner-1.png",
              "role": "image",
              "contentType": "image/png",
              "contentLength": 33902,
              "width": 920,
              "height": 920
            },
            {
              "url": "https://assets.hosted.topsort.com/c27c9cd94badc90fb50827e144dfacb2f51a601560905b950f525cec725ea85f/example-logo-1.png",
              "role": "logo",
              "contentType": "image/png",
              "contentLength": 80648,
              "width": 264,
              "height": 264
            }
          ],
          "campaignId": "018f3ff3-0d7c-7b75-bf99-629c62c09dc3"
        },
        {
          "rank": 2,
          "resolvedBidId": "ChAGc-G66Wt7LKQEOcW8VBdIEhABk0pue7N5wYmzE04uO_iOGhABjr4Lt_J0_a7Xv_uIfyOXIgUKATgQATDrrg8",
          "productId": "8",
          "title": "Brand Example Promo 2",
          "assets": [
            {
              "url": "https://assets.hosted.topsort.com/c049a46d834ab071cdde63e401d4efcd554e1a124f05c4ba9b3743fed2d43c4b/example-banner-2.jpeg",
              "role": "image",
              "contentType": "image/jpeg",
              "contentLength": 4505,
              "width": 403,
              "height": 125
            },
            {
              "url": "https://assets.hosted.topsort.com/db41a8b8b22c5ed9091f9f154b552b6bc1d1dbeb85059190f1c3b202977938f1/example-logo-2.png",
              "role": "logo",
              "contentType": "image/png",
              "contentLength": 34747,
              "width": 140,
              "height": 160
            }
          ],
          "campaignId": "01934a6e-7bb3-79c1-89b3-134e2e3bf88e"
        }
      ],
      "error": false
    }
  ]
}
```

### Resposta Sem Vencedores

Exemplo de resposta quando nenhum vencedor é encontrado:

```json theme={null}
{
  "results": [
    {
      "winners": [],
      "error": false
    }
  ]
}
```

***

## **Leitura Adicional**

Para exemplos adicionais e casos de uso:

* [Criar Leilões de Listings Patrocinados](/en/api-reference/examples/sponsored-listings)
* [Criar Leilões de Banners Patrocinados](/en/api-reference/examples/sponsored-banners)

***