Listings for sponsored brands
Learn how to use the auctions API to create listing auctions for sponsored brands.
Promote brands, restaurants, hotels, and more with sponsored brands using unique product_id
s, specified sponsored slots, and auction requests, similar to sponsored listings.
Display sponsored brands on dedicated pages, search results, category pages, or homepages. Auction requests for sponsored brands follow the same format as sponsored listings.
Request Example
For one sponsored brand on the “brands” page, use this auction request:
{
"auctions": [
{
"winners": 1,
"products": {
"ids": [
"p_PJbnN",
"p_ojng4",
"p_8VKDt",
"p_Mfk15"
]
}
}
]
}
Response
The response includes ranked auction results, providing the product_id
of the winning brand. An empty response occurs if there are no winners or an error. In such cases, append organic results. A new boolean variable, error, indicates successful auction resolution.
Example API V2 JSON-format response:
{
"results": [
{
"winners": [
{
"rank": 1,
"productId": "product",
"title": "The title of the sponsored brand campaign",
"resolvedBidId": "WyJiX01mazE1IiwiMTJhNTU4MjgtOGVhZC00Mjk5LTgzMjctY2ViYjAwMmEwZmE4IiwibGlzdGluZ3MiLCJkZWZhdWx0IiwiIl0=",
"assets": {
"url": "https://url.to/image",
"contentType": "image/png",
"contentLength": 12345,
"width": 300,
"height": 250
}
}
],
"error": false
},
]
}