support Contact support
    • Kamino
    • Developers
    • On-site ad integration
    • Render ads
    • Display and video formats

    Ad format: Square

    Table of Contents

    Overview Example Required assets Technical details Tracking Sample responses Sample response: square Sample response: square-display

    Overview

    This document contains information about the Square format.

    Example

    Default (16:9 video)

    Required assets

    To build this format, you need the following assets:

    • A video or an image.
    • A preview image (for the video version).
    • A title and a description.

    This format doesn't include any products.

    Technical details

    • The format width is fixed to 100% of its container.
    • The format is fixed to 300x250 px.
    • The video block is locked to a 16:9 ratio.

    Tracking

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

    Trigger Beacon Click_zone Action Stop time Product_ID Version
    Click on add to basket button clickBeacon product add-to-cart   123456789 Display/Video
    Click on add to list button clickBeacon product add-to-list   123456789 Display/Video
    Click on carrousel left arrow clickBeacon format nav-next     Display/Video
    Click on carrousel right arrow clickBeacon format nav-prev     Display/Video
    Click on mute button clickBeacon video mute     Video
    Click on product information with redirect clickBeacon product product-page   123456789 Display/Video
    Click on text or CTA with redirect clickBeacon format redirect     Display
    Click on unmute button clickBeacon video unmute     Video
    Format inserted on the page impBeacon         Display/Video
    Format on screen - 50% - 0s viewBeacon     0   Display/Video
    Format on screen - 50% - 1s pviewBeacon     1   Display/Video
    Format on screen - 50% - 2s pviewBeacon     2   Display/Video
    Scroll-in to display at least 50% of the video videoBeacon   play % of completion (rounded down integer)   Video
    Scroll-out to display less than 50% of the video videoBeacon   pause % of completion (rounded down integer)   Video

    Video is paused

    Click on video to start

    		 clickBeacon video play % of completion (rounded down integer)   Video

    Video is playing

    Click on video to pause

    		 clickBeacon video pause % of completion (rounded down integer)   Video
    Video playing on screen videoBeacon   step 25   Video
    Video playing on screen videoBeacon   step 50   Video
    Video playing on screen videoBeacon   step 75   Video
    Video playing on screen videoBeacon   step 100   Video
    Video starts playing videoBeacon   step 0   Display/Video

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

    VIDEO tracker must only be fired once per page, except for actions pause and play.

    Sample responses

    Sample response: square

    {
   "ads":[
      {
         "creativeId":126,
         "format":"square",
         "zoning":"middle-top",
         "placement":"square-middle-top-1",
         "assets":{
            "videos":[
               {
                  "url":"https://cdn.kaminoretail.io/creative-assets/nespresso/nespresso_v.mp4",
                  "mimetype":"video/mp4"
               }
            ],
            "images":[
               {
                  "id":"previewVideoImage",
                  "width": 298,
                  "height": 530,
                  "url":"https://cdn.kaminoretail.io/creative-assets/nespresso/nespresso_v.png",
                  "mimetype":"image/png"
               }
            ],
            "texts":[
               {
                  "id":"title",
                  "value":"Title text",
                  "redirect":"https://www.retailer.com/redirect_page"
               },
               {
                  "id":"paragraph",
                  "value":"This is a paragraph",
                  "redirect":"https://www.retailer.com/redirect_page"
               }
            ],
            "buttons":[
               {
                  "id":"mainButton",
                  "value":"En savoir plus",
                  "style":"primary",
                  "redirect":"https://www.retailer.com/redirect_page"
               }
            ]
         },
         "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
      }
   ]
}

    Sample response: square-display

    {
   "ads":[
      {
         "creativeId":126,
         "format":"square-display",
         "zoning":"middle-top",
         "placement":"square-display-middle-top-1",
         "assets":{
            "images":[
               {
                  "id":"bgImage",
                  "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"
               }
            ]
         },
            "texts":[
               {
                  "id":"title",
                  "value":"Title text",
                  "redirect":"https://www.retailer.com/redirect_page"
               },
               {
                  "id":"paragraph",
                  "value":"This is a paragraph",
                  "redirect":"https://www.retailer.com/redirect_page"
               }
            ],
            "buttons":[
               {
                  "id":"mainButton",
                  "value":"En savoir plus",
                  "style":"primary",
                  "redirect":"https://www.retailer.com/redirect_page"
               }
            ]
         },
         "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"
      }
   ]
}

    RELATED ARTICLES