Skip to main content
Topsort allows the creation of campaigns targeted to specific placements and contexts. Depending on the placements and contexts selected, each campaign participates in the correct auctions.

​
How It Works

1

Campaign Setup

On campaign creation, three types of placements/contexts are available:
2

Automatic

This type of setup will return winners when the auction request has the specific product ID in it, allowing for the campaign to participate wherever the marketplace thinks it’s relevant. By default, all the product categories are also included as relevant contexts.
Example: a campaign having the product Sneakers (id sneakers-123) with automatic targeting will have a bid that will be triggered by auctions having sneakers-123 in the request. It will also participate in an auction with the category sneakers
3

Keywords

Shows the products based on the campaign or product level keywords. If the searchQuery sent on the auction request matches any of the selected keywords, then the items will participate.
Example: a campaign with the keyword shoes will have a bid that will participate by auctions having the searchQuery shoes. This applies to all ad formats.
4

Categories

Items participate on the auction based on the pre-selected categories for the campaign.
Example: a campaign having the category running-sneakers as the target will have a bid that will be triggered by auctions having the category running-sneakers in the request. This applies to all ad formats.
5

Auction Process

During an auction, the placement/context can be provided in the body of the request. The following auction request can be used to retrieve winners with those three contexts/placements:
Example of auction request for sponsored listings:
{
  "auctions": [
    {
      "type": "listings",
      "slots": 1,
      "products": {
        "ids": [
          "sneakers-123"
        ]
      }
    },
    {
      "type": "listings",
      "slots": 1,
      "searchQuery": "shoes"
    },
    {
      "type": "listings",
      "slots": 1,
      "category": {
        "id": "running-sneakers"
      }
    }
  ]
}
Example of auction request for banner ads:
{
  "auctions": [
    {
      "type": "banners",
      "slots": 3,
      "slotId": "backtoschool-carousel"
    }
  ]
}
Example of auction request for sponsored brands:
{
    "auctions": [
        {
            "winners": 2,
            "placementId": "some-placement",
            "triggers": {
                "products": {
                    "ids": [
                        "1", "8"
                    ]
                }
            }
        }
    ]
}
Last updated: