Ad format: Squad
Overview
This document contains information about the Squad format.
Example
Default (16:9 video)
Required assets
To build this format, you need the following assets:
- A video or an image.
- A list of products.
Customizations
See Squad format customization.
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 image | clickBeacon | format | redirect | Display | ||
| Click on mute button | clickBeacon | video | mute | Video | ||
| Click on product information with redirect | clickBeacon | product | product-page | 123456789 | Display/Video | |
| Click on unmute button | clickBeacon | video | unmute | Video | ||
| Format can't be displayed because products are not available | noshowBeacon | no-stock | Display/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: squad
{
"ads":[
{
"creativeId":126,
"format":"squad",
"zoning":"middle-top",
"placement":"squad-middle-top-1",
"assets":{
"video":[
{
"url":"https://cdn.kaminoretail.io/creative-assets/nespresso/nespresso_v.mp4"
"mimetype":"video/mp4"
}
],
"products":[
{
"id":"7164483",
"name":"Cafetière à dosette ou capsule Magimix NESPRESSO VERTUO POP Noir 11729",
"price":"99",
"salePrice":"79",
"link":"https://www.retailer.com/nav/achat/petit_electromenager/expresso_cafetiere/cafetiere_dosette/magimix_pop_noir_11729.html",
"image":"https://image.retailer.com/petit_electromenager/expresso_cafetiere/cafetiere_dosette/magimix_pop_noir_11729_c2304287164483A_160155086.png",
"brand":"Magimix",
"inStock":true,
"lastStockUpdate":"",
"customerRating":"3,700",
"extra":{
}
},
{
"id":"7164491",
"name":"Cafetière à dosette ou capsule Magimix NESPRESSO VERTUO POP BLEU 11731",
"price":"99",
"salePrice":"79",
"link":"https://www.retailer.com/nav/achat/petit_electromenager/expresso_cafetiere/cafetiere_dosette/magimix_pop_bleu_11731.html",
"image":"https://image.retailer.com/petit_electromenager/expresso_cafetiere/cafetiere_dosette/magimix_pop_bleu_11731_c2305027164491A_102407706.png",
"brand":"Magimix",
"inStock":true,
"lastStockUpdate":"",
"customerRating":"4,500",
"extra":{
}
}
],
"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"
}
]
}Sample response: squad-display
{
"ads":[
{
"creativeId":126,
"format":"squad-display",
"zoning":"middle-top",
"placement":"squad-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"
}
]
},
"products":[
{
"id":"7164483",
"name":"Cafetière à dosette ou capsule Magimix NESPRESSO VERTUO POP Noir 11729",
"price":"99",
"salePrice":"79",
"link":"https://www.retailer.com/nav/achat/petit_electromenager/expresso_cafetiere/cafetiere_dosette/magimix_pop_noir_11729.html",
"image":"https://image.retailer.com/petit_electromenager/expresso_cafetiere/cafetiere_dosette/magimix_pop_noir_11729_c2304287164483A_160155086.png",
"brand":"Magimix",
"inStock":true,
"lastStockUpdate":"",
"customerRating":"3,700",
"extra":{
}
},
{
"id":"7164491",
"name":"Cafetière à dosette ou capsule Magimix NESPRESSO VERTUO POP BLEU 11731",
"price":"99",
"salePrice":"79",
"link":"https://www.retailer.com/nav/achat/petit_electromenager/expresso_cafetiere/cafetiere_dosette/magimix_pop_bleu_11731.html",
"image":"https://image.retailer.com/petit_electromenager/expresso_cafetiere/cafetiere_dosette/magimix_pop_bleu_11731_c2305027164491A_102407706.png",
"brand":"Magimix",
"inStock":true,
"lastStockUpdate":"",
"customerRating":"4,500",
"extra":{
}
}
],
"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"
}
]
}