Passer au contenu principal
L’API d’enchères de marques sponsorisées vous permet d’organiser des enchères pour promouvoir des marques en utilisant des ressources, du texte et des produits associés.

​
Avant de commencer

Pour utiliser l’API d’enchères de marques sponsorisées, assurez-vous d’avoir effectué les étapes suivantes :
  1. Obtenir une clé API pour l’authentification.
  2. Créer plusieurs campagnes, pour avoir des enchères disponibles pour les enchères.

​
Requête

Le point de terminaison /auctions/sponsored-brand vous permet d’organiser des enchères pour les emplacements de marques sponsorisées. Pour la spécification complète de ce point de terminaison, consultez la documentation de l’API.

​
Exemple de requête

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

​
Exemple de requête avec ciblage géographique

{
  "auctions": [
    {
      "winners": 2,
      "placementId": "some-placement",
      "triggers": {
        "searchQuery": "electronics"
      },
      "geoTargeting": "new-york",
      "opaqueUserId": "user-123"
    }
  ]
}

​
Champs clés :

  • auctions : un tableau contenant des objets d’enchères.
  • winners : le nombre maximum de gagnants pour l’enchère.
  • placementId : l’ID de l’emplacement où l’annonce apparaîtra.
  • triggers : critères de ciblage comprenant :
    • products.ids : un tableau d’ID de produits associés à l’enchère.
    • searchQuery : termes de recherche pour le ciblage basé sur les mots-clés.
    • category.id : catégorie de produit pour un ciblage plus large.
  • geoTargeting : (Optionnel) identifiant de localisation géographique pour le filtrage des campagnes basées sur l’emplacement.
  • opaqueUserId : (Optionnel) identifiant d’utilisateur anonyme pour la personnalisation et le ciblage amélioré.

​
Réponse

Ne mettez pas en cache cette réponse ni ses résultats. Les enchères doivent rester uniques par vue de page pour garantir un bon fonctionnement.La mise en cache peut entraîner des résultats répétés pour plusieurs utilisateurs ou sessions.
Si aucune erreur de requête ne se produit, le point de terminaison renvoie les résultats de l’enchère.

​
Réponse avec gagnants

Exemple de réponse lorsque des gagnants sont trouvés : 
{
  "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
    }
  ]
}

​
Réponse sans gagnants

Exemple de réponse lorsqu’aucun gagnant n’est trouvé : 
{
  "results": [
    {
      "winners": [],
      "error": false
    }
  ]
}

​
Lectures complémentaires

Pour des exemples supplémentaires et des cas d’utilisation :