Saltar al contenido principal
La API de Subastas de Marcas Patrocinadas le permite ejecutar subastas para promover marcas usando assets, texto y productos asociados.

​
Antes de Comenzar

Para usar la API de Subastas de Marcas Patrocinadas, asegúrese de haber completado lo siguiente:
  1. Obtener una API key para autenticación.
  2. Crear varias campañas, para tener ofertas disponibles para las subastas.

​
Solicitud

El endpoint /auctions/sponsored-brand le permite ejecutar subastas para ubicaciones de marcas patrocinadas. Para la especificación completa de este endpoint, consulte la documentación de la API.

​
Ejemplo de Solicitud

{
  "auctions": [
    {
      "winners": 2,
      "placementId": "some-placement",
      "triggers": {
        "products": {
          "ids": ["1", "8"]
        }
      }
    }
  ]
}

​
Campos Clave:

  • auctions: Un array que contiene objetos de subasta.
  • winners: El número máximo de ganadores para la subasta.
  • placementId: El ID de la ubicación donde aparecerá el anuncio.
  • triggers.products.ids: Un array de IDs de productos asociados con la subasta.

​
Respuesta

No almacene en caché esta respuesta ni sus resultados. Las subastas deben permanecer únicas por vista de página para garantizar el funcionamiento adecuado.El almacenamiento en caché puede resultar en resultados repetidos para múltiples usuarios o sesiones.
Si no ocurren errores de solicitud, el endpoint devuelve los resultados de la subasta.

​
Respuesta Con Ganadores

Ejemplo de respuesta cuando se encuentran ganadores: 
{
  "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
    }
  ]
}

​
Respuesta Sin Ganadores

Ejemplo de respuesta cuando no se encuentran ganadores: 
{
  "results": [
    {
      "winners": [],
      "error": false
    }
  ]
}

​
Lectura Adicional

Para ejemplos adicionales y casos de uso: