support Contact support
    • Kamino
    • Developers
    • On-site ad integration
    • Collect data (tracking)

    Ad-centric trackers

    Table of Contents

    Overview Before you start Column definitions Click events Impression and view events No show events Video events

    Overview

    This article outlines all ad-centric trackers that retailers must implement to track user interactions with Kamino-delivered creatives.

    The goal is to ensure that you track every eligible event using the correct URL provided in the Kamino API response, and that you append all necessary parameters based on the triggered event.

    To learn more about configuring formats, see Manage format settings.

    Before you start

    Before implementing any tracker, complete the following steps:

    • Review the introduction to tracking for both site-centric and ad-centric events.
    • Refer to Comply with GDPR privacy framework to ensure that you respect consent.
    • When the user opts in, append the required user parameters to all trackers:
      • user[gdpr_consent] (required)
      • user[session_id] (optional)
      • user[user_id] (required)

    Column definitions

    The following sections contain tables that describe the available trackable events and their associated tracking parameters. The columns used in these tables are defined as follows:

    Column Definition
    Trigger The event that causes the associated tracker to fire.
    Tracking link The name of the tracker from the trackingLinks object of the API.
    Recurrence The tracking frequency. Use unique for only once per placement per page load, or multiple for as often as it happens.
    Param act The action performed, for example, add-to-cart, mute, or step.
    Param click_zone The area clicked: format, product, or video.
    Param st The stop time in seconds or as a percentage of video progress.
    Param product_id The retailer product ID, which must match ad.products[].id from the creatives/fill-grid response.
    Example A sample tracking URL that includes the appropriate parameters.

    Click events

    You can track user clicks and interactions across different zones of the creative, such as product tiles, format components, or videos.

    The events in this section apply to all interactive formats based on their creative, including video, display, and native formats.

    Trigger Tracking link Recurrence param act param click_zone param st param product_id Example
    Add to favorites or wishlist. clickBeacon multiple add-to-list product — 123456789 https://...&tt=CLICK&act=add-to-list&click_zone=product&product_id=123456789
    Click the right navigation arrow to advance, or scroll forward through the carousel. clickBeacon multiple nav-next format — — https://...&tt=CLICK&act=nav-next&click_zone=format
    Click the left navigation arrow to go back, or scroll backward through the carousel. clickBeacon multiple nav-prev format — — https://...&tt=CLICK&act=nav-prev&click_zone=format
    Click the add to cart button. clickBeacon multiple add-to-cart product — 123456789 https://...&tt=CLICK&act=add-to-cart&click_zone=product&product_id=123456789
    Click the format image. clickBeacon multiple redirect format — — https://...&tt=CLICK&act=redirect&click_zone=format
    Click the product tile. clickBeacon multiple product-page product — 123456789 https://...&tt=CLICK&act=product-page&click_zone=product&product_id=123456789
    Click the mute button. clickBeacon multiple mute video — — https://...&tt=CLICK&act=mute&click_zone=video
    Click the pause button on the video. clickBeacon multiple pause video {0-100} — https://...&tt=CLICK&act=pause&click_zone=video&st=86
    Click the play button on the video. clickBeacon multiple play video {0-100} — https://...&tt=CLICK&act=play&click_zone=video&st=27
    Click to open the modal. clickBeacon multiple open-modal format — — https://...&tt=CLICK&act=open-modal&click_zone=format
    Click the unmute button. clickBeacon multiple unmute video — — https://...&tt=CLICK&act=unmute&click_zone=video

    Impression and view events

    These trackers measure ad visibility and viewability. Each tracker must fire only once per ad placement when its corresponding visibility condition is met. 

    The events in this section apply to all ad formats.

    Trigger Tracking link Recurrence param act param click_zone param st param product_id Example
    Format appears on the page. impBeacon unique — — — — https://...&tt=IMP
    Format is 50% in the viewport. viewBeacon unique — — 0 — https://...&tt=VIEW&st=0
    Format is in the viewport for 1 second. pviewBeacon unique — — 1 — https://...&tt=PVIEW&st=1
    Format is in the viewport for two seconds. pviewBeacon unique — — 2 — https://...&tt=PVIEW&st=2

    No show events

    You can use these trackers to track rendering failures and to diagnose integration or product feed issues.

    The events in this section apply to all ad formats.

    Trigger Tracking link Recurrence param act param click_zone param st param product_id Example
    All ad products are out of stock. noshowBeacon unique no-stock — — — https://...&tt=NOSHOW&act=no-stock
    Format container is missing. noshowBeacon unique div — — — https://...&tt=NOSHOW&act=div

    Contact the support team if you encounter other scenarios where an ad format or one of its products, as returned in the Kamino API response, doesn't render on the page. We will work with you to define the appropriate tracker for that use case.

     

    Video events

    You can track video engagement and playback milestones, including completion and auto-interruptions from scrolling.

    The events in this section apply to video-enabled formats.

    Trigger Tracking link Recurrence param act param click_zone param st param product_id Example
    Scroll back into the video (auto-play). videoBeacon multiple play — {0-100} — https://...&tt=VIDEO&act=play&st=8
    Scroll out of the video (auto-pause). videoBeacon multiple pause — {0-100} — https://...&tt=VIDEO&act=pause&st=45
    Video reaches 25%. videoBeacon unique step — 25 — https://...&tt=VIDEO&act=step&st=25
    Video reaches 50%. videoBeacon unique step — 50 — https://...&tt=VIDEO&act=step&st=50
    Video reaches 75%. videoBeacon unique step — 75 — https://...&tt=VIDEO&act=step&st=75
    Video reaches 100%. videoBeacon unique step — 100 — https://...&tt=VIDEO&act=step&st=100
    Video starts playing. videoBeacon unique step — 0 — https://...&tt=VIDEO&act=step&st=0

    RELATED ARTICLES