Learn how to use the auctions API to create auctions for listings and banners.
!"#$%&'()*+,-._/:;<>?@[]^{}~=
SlotID | Landing Page Name | URL or Deeplinks | Width | Height | Additional Width (optional) | Additional Height (optional) |
---|---|---|---|---|---|---|
top-slot-1 | Homepage Christmas | http://example.com/home | 100 | 50 | 40 | 40 |
right-slot-2 | Homepage Christmas | http://example.com/home | 50 | 200 |
SlotID | Width | Height | Alternative Width (optional) | Alternative Height (optional) |
---|---|---|---|---|
category-bottom | 100 | 50 | 40 | 40 |
Variable | Type | Definition | Required/optional | Notes |
---|---|---|---|---|
type | string | Type of auction | required | Must be set as “banners” |
slots | integer | Maximum number of auction winners | required | number of winners you would like the auction to return |
slotId | string | External slot ID provided by the marketplace. | required | Format: ^[\w!\"#$%&'()_+,\-._/:;<>?@\[\]^\{\}~=\\]\_$ |
categoryId | string | Marketplace’s category ID for the auction. | required only if category banners | Defaults to homepage auction if no category ID provided. |
searchQuery | string | required only if search banners *you can pass both categoryID and searchQuery in the same call | Example “blue running shoes” | |
device | string | Target device: desktop or mobile. | optional | Enum: “desktop” or “mobile.” Defaults to “desktop.” |
Variable | Type | Definition |
---|---|---|
resultType | string | ”banners” |
winners.resolvedBidId | string | A Topsort ID to be used when this item is interacted with (for reporting impressions or clicks) |
winners.type | string | Type of the winning bid. Enum: “product”, “vendor”, “brand”, “url”. |
winners.rank | integer | The product’s auction rank indicates its position, with 1 being the winner. In the auction response, the winners array is sorted, and the rank corresponds to the entry’s index. |
winners.id | string | The marketplace’s unique ID for the winning entity. |
winners.asset | array | |
winners.asset.url | string | URL source for a banner asset. The asset is served by Topsort’s CDN, contained in asset array |
picture
element, which will let you provide multiple sources to the client browser. For example, if the asset has 2 sources: