Overview

This document contains information about the Banner format.

Example

Required assets

To build this format, you need the following assets:

• An image (format XL and S)
• A title (field topText)
• A title and a description (fields title and subTitle)
• A redirect (text + URL)

This format doesn't include any products.

The background color of the text part is defined by a HEX color code.

Tracking

For more information about the properties for each beacon type, see Ad-centric trackers.

IMP, VIEW, and PVIEW, and VIDEO trackers must only be fired once per page.

Sample response

{
   "ads":[
      {
         "creativeId":126,
         "format":"banner",
         "zoning":"middle-top",
         "placement":"banner-middle-top-1",
         "assets":{
            "images":[
               {
                  "id":"formatXL",
                  "width": 298,
                  "height": 530,
                  "url":"https://cdn.kaminoretail.io/creative-assets/nespresso/nespresso_h.png",
                  "mimetype":"image/png",
                  "redirect":"https://www.retailer.com/redirect_page"
               },
               {
                  "id":"formatS",
                  "width": 298,
                  "height": 120,
                  "url":"https://cdn.kaminoretail.io/creative-assets/nespresso/nespresso_h.png",
                  "mimetype":"image/png",
                  "redirect":"https://www.retailer.com/redirect_page"
               }
            ],
            "texts":[
               {
                  "id":"topText",
                  "value":"This is a top text",
                  "redirect":"https://www.retailer.com/redirect_page"
               },
               {
                  "id":"title",
                  "value":"Title text",
                  "redirect":"https://www.retailer.com/redirect_page"
               },
               {
                  "id":"subTitle",
                  "value":"This is a subtitle",
                  "redirect":"https://www.retailer.com/redirect_page"
               }
            ],
            "buttons":[
               {
                  "id":"mainButton",
                  "value":"En profiter",
                  "style":"primary",
                  "redirect":"https://www.retailer.com/redirect_page"
               }
            ],
            "styles":[
               {
                  "id":"bgColor",
                  "redirect":null
                  "style":null
                  "value":"#FFCC99"
               }
            ]
         },
         "trackingLinks":{
            "impBeacon":"https://delivery.kaminoretail.io/tracking/creative?cid=10&liid=25&crid=126&tt=IMP&r=retailer&pt=HomePage&pid=&lng=fr-FR&kwds=",
            "clickBeacon":"https://delivery.kaminoretail.io/tracking/creative?cid=10&liid=25&crid=126&tt=CLICK&r=retailer&pt=HomePage&pid=&lng=fr-FR&kwds=",
            "videoBeacon":"https://delivery.kaminoretail.io/tracking/creative?cid=10&liid=25&crid=126&tt=VIDEO&r=retailer&pt=HomePage&pid=&lng=fr-FR&kwds=",
            "viewBeacon":"https://delivery.kaminoretail.io/tracking/creative?cid=10&liid=25&crid=126&tt=VIEW&r=retailer&pt=HomePage&pid=&lng=fr-FR&kwds="
         },
         "campaignId":10,
         "lineItemId":25,
         "sponsored": true,
         "dsa": {
          "buyer": "text",
          "brand": "text"
      }
   ]
}