Ad format: Playbox
Overview
This document contains information about the Playbox format.
Examples
Play button
Overlay (Default 16:9 video)
Required assets
To build this format, you need the following assets:
- A video.
- A list of products.
Customizations
See Playbox 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 |
|---|---|---|---|---|---|
| Click on add to basket button | clickBeacon | product | add-to-cart | 123456789 | |
| Click on add to list button | clickBeacon | product | add-to-list | 123456789 | |
| Click on carrousel left arrow | clickBeacon | format | nav-next | ||
| Click on carrousel right arrow | clickBeacon | format | nav-prev | ||
| Click on mute button | clickBeacon | video | mute | ||
| Click on play button | clickBeacon | format | open-modal | 123456789 | |
| Click on product information with redirect | clickBeacon | product | product-page | 123456789 | |
| Click on unmute button | clickBeacon | video | unmute | ||
| Format can't be displayed because products are not available | noshowBeacon | no-stock | |||
| Format inserted on the page | impBeacon | ||||
| Format on screen - 50% - 0s | viewBeacon | 0 | |||
| Format on screen - 50% - 1s | pviewBeacon | 1 | |||
| Format on screen - 50% - 2s | pviewBeacon | 2 | |||
| Scroll-in to display at least 50% of the video | videoBeacon | play | % of completion (rounded down integer) | ||
| Scroll-out to display less than 50% of the video | videoBeacon | pause | % of completion (rounded down integer) | ||
|
Video is paused Click on video to start |
clickBeacon | video | play | % of completion (rounded down integer) | |
|
Video is playing Click on video to pause |
clickBeacon | video | pause | % of completion (rounded down integer) | |
| Video playing on screen | videoBeacon | step | 25 | ||
| Video playing on screen | videoBeacon | step | 50 | ||
| Video playing on screen | videoBeacon | step | 75 | ||
| Video playing on screen | videoBeacon | step | 100 | ||
| Video starts playing | videoBeacon | step | 0 |
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 response
{
"ads":[
{
"creativeId":374,
"format":"playbox",
"zoning":"middle",
"placement":"playbox-middle-1",
"assets":{
"anchor":[
{
"brand":"Magimix",
"extra":{},
"id":"7164483",
"image":"https://image.retailer.com/petit_electromenager/expresso_cafetiere/cafetiere_dosette/magimix_pop_noir_11729_c2304287164483A_160155086.png",
"in_stock":true,
"last_stock_update":"",
"link":"https://www.retailer.com/nav/achat/petit_electromenager/expresso_cafetiere/cafetiere_dosette/magimix_pop_noir_11729.html"
"name":"Cafetière à dosette ou capsule Magimix NESPRESSO VERTUO POP Noir 11729",
"price":"99",
"sale_price":"79"
},
{
"brand":"Magimix",
"extra":{},
"id":"7164491",
"image":"https://image.retailer.com/petit_electromenager/expresso_cafetiere/cafetiere_dosette/magimix_pop_bleu_11731_c2305027164491A_102407706.png",
"in_stock":true,
"last_stock_update":"",
"link":"https://www.retailer.com/nav/achat/petit_electromenager/expresso_cafetiere/cafetiere_dosette/magimix_pop_bleu_11731.html"
"name":"Cafetière à dosette ou capsule Magimix NESPRESSO VERTUO POP BLEU 11731",
"price":"99",
"sale_price":"79"
}
},
],
"video":{
"url":"https://cdn.kaminoretail.io/creative-assets/nespresso/nespresso_h.mp4"
"mimetype":"video/mp4"
}
},
"styles":[
{
"id": "playPosition",
"redirect": null,
"style": null,
"value": "center" or "top-right" }
],
"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":{
"viewBeacon": "https://delivery.kaminoretail.dev/tracking/creative?cid=129&liid=320&crid=374&tt=VIEW&r=retailer&pt=Search&pid=&kwds=ordinateur_noir&pl=playbox-middle-1&ad_request_id=eaeaed8f3fd84da0ae5897f19296ad4",
"videoBeacon": "https://delivery.kaminoretail.dev/tracking/creative?cid=129&liid=320&crid=374&tt=VIDEO&r=retailer&pt=Search&pid=&kwds=ordinateur_noir&pl=playbox-middle-1&ad_request_id=eaeaed8f3fd84da0ae5897f19296ad4",
"pviewBeacon": "https://delivery.kaminoretail.dev/tracking/creative?cid=129&liid=320&crid=374&tt=PVIEW&r=retailer&pt=Search&pid=&kwds=ordinateur_noir&pl=playbox-middle-1&ad_request_id=eaeaed8f3fd84da0ae5897f19296ad4",
"noshowBeacon": "https://delivery.kaminoretail.dev/tracking/creative?cid=129&liid=320&crid=374&tt=NOSHOW&r=retailer&pt=Search&pid=&kwds=ordinateur_noir&pl=playbox-middle-1&ad_request_id=eaeaed8f3fd84da0ae5897f19296ad4",
"impBeacon": "https://delivery.kaminoretail.dev/tracking/creative?cid=129&liid=320&crid=374&tt=IMP&r=retailer&pt=Search&pid=&kwds=ordinateur_noir&pl=playbox-middle-1&ad_request_id=eaeaed8f3fd84da0ae5897f19296ad4",
"loadBeacon": "https://delivery.kaminoretail.dev/tracking/creative?cid=129&liid=320&crid=374&tt=LOD&r=retailer&pt=Search&pid=&kwds=ordinateur_noir&pl=playbox-middle-1&ad_request_id=eaeaed8f3fd84da0ae5897f19296ad4",
"clickBeacon": "https://delivery.kaminoretail.dev/tracking/creative?cid=129&liid=320&crid=374&tt=CLICK&r=retailer&pt=Search&pid=&kwds=ordinateur_noir&pl=playbox-middle-1&ad_request_id=eaeaed8f3fd84da0ae5897f19296ad4"
},
"campaignId":129,
"lineItemId":320,
"sponsored": true,
"dsa": {
"buyer": "text",
"brand": "text"
}
]
}