Skip to content

Promotional materials

Introduction

Our servers can handle thousands of RPS on a single machine. With autoscaling enabled, you don't have to think about hosting for your promotional materials such as landing pages and banners. We also provide CDN service to lower response times and traffic costs.

We support the following types of promotional assets:

  • HTML landing page
  • HTML banner
  • Any image as a banner (in PNG, JPEG, GIF format)

You just need to create a landing page in HTML format, package it in a ZIP archive and upload it to the "Promo Materials" section in your admin area.

Requirements

  • HTML landing page or HTML banner must be a static HTML page, PHP scripts are not allowed. It must be packed to ZIP archive with mandatory index.html file in the archive root.
  • To design the page and interact with the user, it is allowed to use CSS styles, JavaScript files, images in various formats, video files.
  • Styles, scripts, pictures can be either embedded inside an HTML file or inserted via relative paths.
  • CDN service is provided automatically. It is not recommended to use external links to resources such as Google Fonts CDN, CDN with popular scripts and styles (jQuery, Bootstrap).
  • It is recommended to optimize image resolution and compression settings to speed up loading times, preferably using JPEG, PNG or SVG formats.
  • It is not allowed to use images or videos containing trademarks, names of sites, companies, teams, championships, etc., requiring explicit consent to use their symbols for advertising purposes, without obtaining the appropriate permission. If we receive a complaint about such content, it will be blocked immediately.

Server-Side Parameters

When serving a visit to HTML landing page or HTML banner, server inserts a special script to the end of <head> HTML section, which sets the window.serverData parameter with the following fields:

  • btag: Unique visit ID
  • clickUrl: URL to redirect visitor when interacted with the page
  • marketingMaterialId: Unique ID of this promotional material
  • promoApiBaseUrl: Promotional API base URL
  • queryCurrency: User-selected currency code passed via currency GET parameter
  • queryLocale: User-selected language code passed via lang GET parameter
  • siteId: Internal brand ID
  • sitePath: Target site path passed via p GET parameter
  • trackingParams: Query GET parameters
  • trackingUrlId: Unique tracking ID passed via id GET parameter
  • visitorData.countryCode: Visitor's country code (ISO 3166-1 alpha-2)
  • visitorData.currencyCode: Automatically detected currency code for visitor's country (ISO 4217)
  • visitorData.browser: Visitor's browser name
  • visitorData.browserVersion: Visitor's browser version
  • visitorData.os: Visitor's operating system name
  • visitorData.osVersion: Visitor's operating system version
  • visitorData.deviceVendor: Visitor's device vendor (Unknown if can't be detected)
  • visitorData.deviceModel: Visitor's device model (Unknown if can't be detected)
  • visitorData.isMobile: true if this page is accessed from a mobile device
  • visitorData.languageCode: User system language code (ISO 639-1)

Here is an example of inserted window.serverData:

{
  "visitorData": {
    "countryCode": "DE",
    "currencyCode": "EUR",
    "browser": "Chrome",
    "browserVersion": "96",
    "os": "macOS",
    "osVersion": "10.15.7",
    "deviceVendor": "Apple",
    "deviceModel": "Macintosh",
    "isMobile": false,
    "languageCode": "en"
  },
  "trackingUrlId": "29R",
  "trackingParams": {},
  "queryLocale": "",
  "queryCurrency": "",
  "sitePath": "",
  "btag": "d_735m_8299c_ts_WmL7JoQTa4TqxYEvrRgxAm",
  "clickUrl": "https://redirect.example.com/29R?btag=d_735m_8299c_ts_WmL7JoQTa4TqxYEvrRgxAm&mid=0cc063a7-4a01-4d19-ab5b-471459b43503&ml=&h=OKyZKZLsBch07fy0qAl%2BR%2FkSek8%3D&ref=",
  "siteId": "test",
  "marketingMaterialId": "0cc063a7-4a01-4d19-ab5b-471459b43503"
}

Last update: January 24, 2024