Tracking ad-related activity
Commerce Video is in Beta
The documentation and features are likely to change, and the product might contain bugs.
Please report any issues and check back for updates.
With Commerce Video formats, the beacons have three different levels, meaning that each beacon will be linked to either:
- An event that relates to the format/placement itself;
- An event that relates to the individual SKUs within the format (if SKUs are available in the format);
- An event that relates to video, via the VAST video player.
The distinctions between these three levels of beacons are outlined in the tables below, along with the beacons names and descriptions.
Except when stated otherwise, the beacons should be fired only once per page load.
All video tracking beacons (related to the 3rd kind of event we mentioned above) will be fired directly by the video player, on the client-side, after loading the VAST XML file.
It is highly recommended that Criteo beacons be triggered client-side directly from the browser. If you intend to implement server-side beacons, please consult with and inform your Criteo technical team in advance.
Format Level Beacons
| Beacon Name | Beacon Description |
|---|---|
OnLoadBeacon | Indicates that the format (video + SKUs if applicable) is rendered on the page, even if not viewable yet. |
OnViewBeacon | Indicates that the format is viewed by the user (viewability = more than 50% of the format in the user's viewport for 1 second). Note: this indicates the viewability of the format. However, video viewability (more than 50% of the format in the user’s viewport for two consecutive seconds) is tracked with OMID capabilities (see the "Additional verification with OMID compatible scripts” section). This beacon is not used to track video viewability. |
OnClickBeacon (200) | Indicates that the format has been clicked by the user on a clickable and redirectable element that is neither the video nor the product tile (example: a CTA, a clickable text around the video...). If there is no any other clickable element than the video or SKUs, you can ignore this beacon. Notes: 1. Clicks on SKUs should use the OnClickBeacon at SKU level.2. Clicks on the video itself should use the click tracking beacon in the VAST XML. |
OnFileClickBeacon | Please disregard this beacon. |
OnBundleBasketChangeBeacon | Please disregard this beacon. |
SKU Level Beacons
| Beacon Name | Beacon Description |
|---|---|
OnLoadBeacon | Indicates that the product tile is rendered on the page (even if not viewable yet). |
OnViewBeacon | Indicates that the product tile is viewed by the user (viewed = more than 50% of the product in the user's viewport for 1 second). |
OnClickBeacon (200) or ProductPage (302) | This beacon is triggered when a user clicks on an element (image, text) of the product tile that redirects to the product page. |
OnBasketChangeBeacon | This beacon is triggered when the user adds a product to their cart. If there is no Add to Cart functionality available, please disregard. The beacon can be fired multiple times if the user repeatedly clicks the Add-to-Cart CTA. |
OnWishListBeacon | This beacon is triggered when the user adds a product to their wishlist. If no add-to-Wishlist CTA is available, it can be disregarded. The beacon can be fired multiple times if the user repeatedly clicks the Add-to-Wishlist CTA. |
VAST XML Level Beacons
| Name | Description |
|---|---|
Impression | Indicates that the video is rendered on the page (even if not viewable yet). |
Tracking event="start" | Indicates that the video has started and should be triggered when the video enters in 50% of the user’s viewport. |
Tracking event="firstQuartile | Must be triggered when 25% of the video has been played. |
Tracking event="midpoint" | Must be triggered when 50% of the video has been played. |
Tracking event="thirdQuartile" | Must be triggered when 75% of the video has been played. |
Tracking event="complete" | Must be triggered when 100% of the video has been played. |
ClickTracking | Must be triggered every time the user clicks on the video and gets redirected to the landing page stored in the \<ClickThrough id="Criteo"> node of the VAST XML file. This beacon can be fired multiple times per page load, for every click on the video.Do not trigger this beacon for clicks on the interactive buttons ( pause / resume / mute / unmute). Please refer to the associated tracking events below for those actions. |
Tracking event="mute" | Must be triggered every time the user clicks the Mute button of the video player when the video is already unmuted. This beacon can be fired multiple times per page load, for every click on the Mute button. The video should begin in a muted state when in the viewport.This action must not be triggered at the start of the video. It should only be initiated when the user actively mutes the video by clicking the Mute button. |
Tracking event="unmute" | Must be triggered every time the user clicks the Unmute button of the video player when the video is already muted. This beacon could be fired multiple times per page load, for every click on the Unmute button. |
Tracking event="pause" | Must be triggered every time the user clicks the Pause button of the video player when the video is already playing. This beacon could be fired multiple times per page load, for every click on the Pause button.If the decision is made not to display a pause/resume button in the player, this beacon can be ignored. This beacon should only be triggered by the button click and should not be triggered when the video pauses by itself due to leaving the viewport. If there is no redirection link provided in the VAST XML, a click on the video itself should pause/resume the video and this beacon should be fired. |
Tracking event="resume" | Must be triggered every time the user clicks the Play button of the video player when the video is already paused. This beacon can be fired multiple times per page load, for every click on the Resume button.If the decision is made not to display a pause/resume button in the player, this beacon can be ignored. This beacon should only be triggered by the button click and should not be triggered when the video autonomously resumes after being paused by leaving the viewport and subsequently returning. If there is no redirection link provided in the VAST XML, a click on the video itself should pause/resume the video and this beacon should be fired. |
Updated 3 months ago
What’s Next