Ad format: Masthead
Overview
This document contains information about the Masthead format.
Example
Required assets
To build this format, you need the following assets:
- An image and a video (optional).
- A list of products.
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 image | clickBeacon | format | redirect | ||
| Click on mute button | clickBeacon | video | mute | ||
| 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 when the video is visible to the user clicking or swiping to the specific ad, except for actions pause and play.
Sample response
{
"adRequestId": "56b07818d0cd43eb88c3aa2324b9e",
"ads": [
{
"creativeId": 987,
"format": "masthead",
"zoning": "top",
"placement": "masthead-top-1",
"assets": {
"videos": [
{
"height": 360,
"mimetype": "video/mp4",
"url": "https://cdn.kaminoretail.io/creative-assets/3/2025/9/19/446f7948-aa3c-476f-8af1",
"width": 640
}
],
"images": [
{
"height": 402,
"id": "backgroundDesktop",
"mimetype": "image/jpeg",
"redirect": null,
"url": "https://cdn.kaminoretail.io/creative-assets/3/2025/9/19/836c3299-cd83-428d-8e59",
"width": 1242
},
{
"height": 402,
"id": "backgroundMobile",
"mimetype": "image/jpeg",
"redirect": null,
"url": "https://cdn.kaminoretail.io/creative-assets/3/2025/9/23/1285db78-47ef-462e-ab",
"width": 1242
}
],
"video": {
"height": 360,
"mimetype": "video/mp4",
"url": "https://cdn.kaminoretail.io/creative-assets/3/2025/9/19/446f7948-aa3c-476f-8af1-a17",
"width": 640
}
},
"products": [
{
"id": "0000000000012",
"name": "Masque LED SHARK CryoGlow Lilas",
"price": "",
"salePrice": "349.99",
"link": "https://www.boulanger.com/ref/15",
"image": "https://boulanger.scene7.com/is/image/Boulanger/062235",
"brand": "SHARK",
"inStock": true,
"lastStockUpdate": "",
"customerRating": null,
"extra": {}
},
{
"id": "00000000000122",
"name": "Fer multistyle SHARK Flexstyle Glam",
"price": "",
"salePrice": "399.99",
"link": "https://www.boulanger.com/ref/",
"image": "https://boulanger.scene7.com/is/image/Boulanger/06",
"brand": "SHARK",
"inStock": true,
"lastStockUpdate": "",
"customerRating": null,
"extra": {}
},
{
"id": "0000000000012",
"name": "Fer multistyle SHARK Flexstyle HD466PLEU Lilas",
"price": "",
"salePrice": "329.98",
"link": "https://www.boulanger.com/ref/1",
"image": "https://boulanger.scene7.com/is/image/Boulanger/06223",
"brand": "SHARK",
"inStock": true,
"lastStockUpdate": "",
"customerRating": "4.6842",
"extra": {}
},
{
"id": "000000000001204550",
"name": "Fer multistyle SHARK Flexstyle champagne HD446SLEU",
"price": "299.99",
"salePrice": "199.99",
"link": "https://www.boulanger.com/ref/1",
"image": "https://boulanger.scene7.com/is/image/Boulanger/062235630",
"brand": "SHARK",
"inStock": true,
"lastStockUpdate": "",
"customerRating": "4.3966",
"extra": {}
}
],
"trackingLinks": {
"clickBeacon": "https://delivery.kaminoretail.io/tracking/creative?cid=7057&liid=24058&crid=98700&tt=CLICK&r=boulanger&pt=Category&pid=beaute_-_sante%3Ecoiffure&pl=masthead-top-1&ad_request_id=56b07818d0cd43eb88ca2324b9",
"viewBeacon": "https://delivery.kaminoretail.io/tracking/creative?cid=7057&liid=24058&crid=98700&tt=VIEW&r=boulanger&pt=Category&pid=beaute_-_sante%3Ecoiffure&pl=masthead-top-1&ad_request_id=56b07818d0cdb88c3aa2324b9",
"pviewBeacon": "https://delivery.kaminoretail.io/tracking/creative?cid=7057&liid=24058&crid=98700&tt=PVIEW&r=boulanger&pt=Category&pid=beaute_-_sante%3Ecoiffure&pl=masthead-top-1&ad_request_id=56b07818d0cd43eb88ca2324b",
"noshowBeacon": "https://delivery.kaminoretail.io/tracking/creative?cid=7057&liid=24058&crid=98700&tt=NOSHOW&r=boulanger&pt=Category&pid=beaute_-_sante%3Ecoiffure&pl=masthead-top-1&ad_request_id=56b07818d0cd43eb88ca2324b",
"impBeacon": "https://delivery.kaminoretail.io/tracking/creative?cid=7057&liid=24058&crid=98700&tt=IMP&r=boulanger&pt=Category&pid=beaute_-_sante%3Ecoiffure&pl=masthead-top-1&ad_request_id=56b07818d0cd43eb88ca2324b",
"videoBeacon": "https://delivery.kaminoretail.io/tracking/creative?cid=7057&liid=24058&crid=98700&tt=VIDEO&r=boulanger&pt=Category&pid=beaute_-_sante%3Ecoiffure&pl=masthead-top-1&ad_request_id=56b07818d0cd43eb88ca2324b"
}
}
]
}