ePrivacy and GPDR Cookie Consent by Cookie Consent Skip to main content

Embedded web banners: create form & conditions

Personalization/ Embedded web banners tab enables creating and setting rules to display banners that are embedded within a website content and display them to the users of the website.

image-1653569957224.jpg

Prerequisites


To work with web banners, first, they need to be set by the Meiro team:

1. Meiro Events must be implemented. 

2. Meiro Events API connection must be set in the Administration/ Settings tab. 

3. Web banners tabs must be enabled by the administrator for your user role.

4. For embedded web banners it is required to place a DOM element with a unique ID in the HTML code of  the website where the banner will be displayed.


Name embedded web banner

(required)

The name under which the banner will be displayed in the list of banners. This name is only visible within the Personalization tab/ Embedded web banners tab. 


Warning: Depending on the reporting set for measuring embedded web banners performance, changing of the name may influence the report e.g. reporting may be set to track various versions of embedded web banners under various names. Usually, it is the latest name that is used in attributes or reporting, but each name can be tracked as well. Reporting is fully customized for each client. Contact the Meiro team to learn more.

Frequency cap

(optional)

Select frequency cap per user for hour/ day/ 1 session and in total.


User

Each "user" has been assigned a "cookie" and hence is identified as a separate "user". If a user uses a different browser, then will be considered a new user.

Session

Refers to the activity of the user within 30 minutes.

Total

The maximum number of banner impressions for the user. You may set the total number of impressions, without setting other fields in frequency cap.

E.g. Below is an example of a setting with 10 views of an embedded web banner in total and 1 per session per user. 

Priority (required)

It is a number that defines the priority for a display of an embedded web banner. Priority can be set to a whole number between 0 and 10, where 0 is the lowest priority and 10 is the highest. 0 is the default priority.


The Meiro will only show one banner at a time to a user inside a single DOM element specified by ID on the website.


If there are multiple banners for which the display conditions are fulfilled, the banner with the highest priority will be displayed.


If multiple banners have their conditions fulfilled and have the same priority and element ID, the order to display an  embedded banner is random.

Conditions

Conditions are additional rules that must be fulfilled for the banner to be considered for display.

If no conditions are set, the banner will always be considered for display and will be ordered by priority.

The conditions can be nested and the operators at each level of nesting are set to either “and” (all conditions must be fulfilled) or “or” (at least one of the conditions must be fulfilled).

All conditions with equals any of, doesn't equal any of, contains any of, doesn't contain any of operators support copy of multiple values with a copy button.

Categories of conditions (described below):

Browser
Browser storage: cookie

Possible operators: cookie name, data type (boolean, datetime, number, string), and/ or operator (is set/ is not set and operators relevant for the data type). 


Possible operators depend on the expected data type of the cookie value. See the section below for a note about data types and operators and the section for developers for more details.

This condition compares the specified value with the contents of a cookie set in the browser under the specified cookie name.

Additional fields:
Cookie name The name of the cookie whose value you want to compare
Note for developers: the cookie must be accessible to JavaScript code, i.e. it must not be set as “HTTP-only”.
Browser storage: local storage

Possible operators: local storage key, data type (boolean, string, number, datetime), depending on the data type set other operators are possible to set, like operator (is set/ is not set). 


Possible operators depend on the expected data type of the value. See the section below for a note about data types and operators and the section for developers for more details.


This condition compares the specified value with the contents of a local storage item set in the browser under the specified key.


Additional fields

Local storage key The local storage key whose value you want to compare.
Browser: browser name

Possible operators: equals, doesn't equal, equals any of, doesn't equal any of, contains any of, doesn't contain any of. Values are selected from a dropdown list. Possible values are Chrome, Edge, Firefox, Safari, Opera, other.


The user’s browser is detected from the user-agent string.
Browser: language 

Possible operators: equals, doesn't equal, equals any of, doesn't equal any of, contains any of, doesn't contain any of.  Values are selected from a dropdown list.


The language of the user’s browser (retrieved from the window.navigator.language).


Only the first part of the language code (the two-letter code as defined in ISO 639-1) is considered—e.g. if the condition is set to equal “en”, the condition will be fulfilled by values “en”, “en-US”, “en-GB”.
Device

Device: IP address

Possible operators: equals, doesn't equal, equals any of, doesn't equal any of, contains any of, doesn't contain any of. The value field supports string datatype and allows filtering of both IPv4 (including IP addresses with masks, e.g. 193.164.1.0/32) and IPv6.


Comma-separated values can be used in the react select component.


Limitations that may occur:

  • To preserve fast rendering of web banners, this condition works on a "best effort" basis, meaning a banner can still be displayed to an IP address blocked by this condition.
  • The condition relies on Meiro backend API to retrieve the client's IP address. In case the backend API call fails, the banner will still be displayed.
  • This situation should not occur under normal circumstances as the API call is designed as low-latency.
  • However, in case of network problems, high latency between the browser and Meiro API, or overloaded API endpoints, this situation may occur.
  • Since web banners will be rendered, users still may notice events or reported activity from blocked IP addresses, though in negligible volumes.
Device: operating system

Possible operators: equals, doesn't equal, equals any of, doesn't equal any of, contains any of, doesn't contain any of. Values are selected from a dropdown list. Possible values are: Android, iOS, MacOS, Windows, other.


The user’s operating system is detected from the user-agent string.
Device: type

Possible operators: equals, doesn't equal, equals any of, doesn't equal any of, contains any of, doesn't contain any of. Values are selected from a dropdown list. Possible values are: console, desktop, embedded, mobile, smart TV, tablet, wearable.


The user’s device is detected from the user-agent string.
Google Tag Manager
Google Tag Manager

Possible operators: name of GTM DL object, GTM DL path, data type (boolean, datetime, number, string), depending on the set datatype other operators are available: is set, is not set.


Possible operators depend on the expected data type of the value. See the section below for a note about data types and operators and the section for developers for more details.


This condition compares the specified value with the contents of an entry in the GTM data layer. 


Additional fields:

Name of GTM DL object

 The name of the data layer object as it is instantiated in the website; e.g. if your data layer object is accessed under the window.dataLayer, input “dataLayer”.

GTM DL path

Path to the inner value of the data layer, e.g. "key.inner"
Page
Page: hostname

Possible operators: contains, doesn't contain, equals, doesn't equal, equals any of, doesn't equal any of,contains any of, doesn't contain any of.


The hostname of the page, as retrieved from the window.location.hostname i.e. the part of the URL address excluding the protocol prefix (“https://”) and excluding the path (the “/” after the top-level domain and any following text).
Page; pathname

Possible operators: contains, doesn't contain, equals, doesn't equal, equals any of, doesn't equal any of, contains any of, doesn't contain any of.


The pathname of the page, as retrieved from the window.location.pathname i.e. the part of the URL address including the “/” after the top-level domain and any following text, but excluding the query, the part of the URL starting with “?”, if there is any.
Page: title

Possible operators: is set, is not set, contains, doesn't contain, equals, doesn't equal, equals any of, doesn't equal any of, contains any of, doesn't contain any of.


The page title (retrieved from document.title).
Page: URL


The entire URL address of the page the user is on (retrieved from the window.location.href).
Server
Server: Http request

Possible operators: response is OK, is set, is not set when the data type is not selected. If the data type is selected, specify operation and possibly value(s) field,  path in a response to the value which has to be compared.  


Possible operators depend on the expected data type of the value. See the section below for a note about data types and operators and the section for developers for more details.

This condition requests to the provided URL and parses the response as JSON. You can specify the path in the response body that leads to the value that you want to compare.


Additional fields:

URL template

The URL to send the request to. You can use values from cookies and local storage by using placeholders in the URL template: {{cookie:my_cookie_name}} for cookie values, {{ls:my_ls_key}} for local storage. E.g. the placeholder {{cookie:transaction_id}} in the URL will be replaced by the content of a cookie named transaction_id, while the placeholder {{ls:transaction_id}} will be replaced by the content of local storage stored under the key transaction_id.


Note: If the specified cookie or local storage item doesn't exist, the condition will fail.


Note for developers: The values from cookies/local storage are encoded by the SDK using the JavaScript function encodeURIComponent() before being inserted into the URL. Do not store encoded values—they would get encoded twice!
Path in response body The path to the value that you want to compare, in standard JavaScript notation, i.e. the . delimiter for accessing the property of an object and [] for accessing an index of an array (array indexes start at 0). For example, in the response { a: { b: ["x", { c: 42 }] } }, the path a.b[1].c retrieves the value 42.


There is an additional operator for this condition, "response is OK". For this operator, the condition will simply pass if the response HTTP status code is >=200 and <400.


Note for developers: The content of the response body is stored by the SDK and can be accessed from inside the HTML banner for use in the banner code. See the section for developers for details.



Example for “response is OK”: On the page, you have a cookie with the name “last_order_id” and value “123”, and a local storage item with the key “user_email” and value “user@example.com”. Type in the URL “https://my-api.com/orders/{{cookie:last_order_id}}?email={{ls:user_email}}”. The Meiro Events SDK requests to https://my-api.com/orders/123?email=user%40example.com. If the response returns OK, this condition will pass.


Warning: If you add segments in the embedded web banner for the first time, please reach out to the Meiro team to set up servers for it and to ensure the server sizing is upgraded.  


Learn more: about use cases with this conditions: abandonned basket, form with promo code.
Segment
Segment

Learn more: about how to display web banner to segmented audience.
Show after
Show after: pageviews

Possible operators: greater than, less than, in between, equals, doesn't equal. 


Select conditions for page views when the embedded web banner will be triggered. All page views are counted within one session.
Time
Time: Datetime

Possible operators: until, since, since-until.


This condition compares the time of the page view with an absolute point in time, the evaluation doesn’t take into account the user’s timezone. At any given moment, it will evaluate the same for all users around the world.


Remember: In Meiro Business Explorer, input the date time value in your timezone.


Example: You have a campaign that ends on a particular day at noon of US eastern time (ET). You want to stop showing a banner when the campaign ends. You are currently using Meiro Business Explorer from Prague (CET). You select the operator “until” and input the date time in your timezone at 6 PM (which equals noon in ET). On the given day, at noon ET (6 PM your time), users all around the world will stop seeing the banner at the same time, regardless of their timezone.
Time: day of the week

Possible operators: equals, doesn't equal, equals any of, doesn't equal any of, contains any of, doesn't contain any of. Values are selected from a dropdown list (Monday–Sunday).


This condition takes the user’s timezone into account, i.e. which day of the week it is for the user.
Time: hours of the day

Possible operators: equals, doesn't equal, until, since, since-until. Possible values are integers 0–23.


This condition takes the user’s timezone into account, i.e. which hour of the day it is for the user e.g. if set to “equals 16”, this condition will pass if it’s between 16:00:00 and 16:59:59 for the user.
Traffic source

Traffic source: UTM campaign

Traffic source: UTM content

Traffic source: UTM medium

Traffic source: UTM source

Traffic source: UTM term

Possible operators: is set, is not set, contains, doesn't contain, equals, doesn't equal, equals any of, doesn't equal any of, contains any of, doesn't contain any of.


The value of the “utm_campaign”/ "utm_content"/“utm_medium”/ “utm_source”/"utm_term" part of the query in the URL address.
Traffic source: referer

Possible operators: is set, is not set, contains, doesn't contain, equals, doesn't equal, equals any of, doesn't equal any of, contains any of, doesn't contain any of.


The value of the “referrer” part of the query in the URL address.

Remember: strings are converted to lowercase. When evaluating conditions that compare strings of text, all strings are compared as case insensitive.


Cookie, local storage, and Google Tag Manager condition data types and operators

For conditions that are based on cookie/local storage/GTM values, it is possible to select the expected data type of the value retrieved:

  • If no data type is selected, you can choose the operators “is set” and “is not set”, which will test whether there is a value stored under that name at all.
  • If you select a data type, you will then be able to select from operators available for that data type.
  • If the value is not set, all comparisons will be evaluated as false.
  • If you want to be able to distinguish a scenario where the value is set but "doesn’t equal" your provided value is recommended you set up two conditions: one for “is set”, and one for the comparison you want to make.

Relative DateTime data type

Whereas the "DateTime" data type compares the stored timestamp value to an absolute point in time, the "relative datetime" type compares the value to some moment in time relative to when the customer is viewing the page.

Just like for the "DateTime" type, the operators available are "since", "until", and "since–until". The moment in time that is compared to the stored timestamp can be either before or after the moment when the user is viewing the page. 

For example, if you set the condition to:

since 1 hour before

The condition will pass if the timestamp denotes a moment in time that is 1 hour old or less at the moment of the page view (which means it can also be any time in the future)
until 1 hour before

The condition will pass if the timestamp denotes a moment in time that is 1 hour old or more at the moment of the page view
since 1 hour after

The condition will pass if the timestamp denotes a moment in time that is 1 hour in the future or more at the moment of the page view
until 1 hour after

The condition will pass if the timestamp denotes a moment in time that is 1 hour in the future or less at the moment of the page view (which means it can also be any time in the past)
since 1 hour before/ until 1 hour after

The condition will pass if the timestamp denotes a moment in time that is no more than 1 hour old, but also no more than 1 hour in the future, at the moment of the page view

Learn more: see the section for developers for more details.

Embedded web banner section


HTML Template Gallery

Gallery with HTML templates allows users to create web banners with already prescribed HTML code. Here you can remind the customers of their purchase intention, offer a time-limited discount, give a promo code, etc.

Learn more: about use cases and how to use HTML template gallery


Image banner

Image banners consist entirely of the specified image. 


The dimensions of the image banner are the same as the dimensions of the specified image. If the width is higher than the width of the specified Element ID, then the image will take 100% of the element specified by ID. It is possible to override those setting with CSS on the website.


Destination URL: The URL that the user will be taken to after clicking on the banner (the new page will open in the same window as the current page).. If no destination URL is specified, nothing happens on click.


Image upload:

Upload the image for the banner.

Image type: APNG, AVIF, gif, jpg, png, svg, webp
Image size: 100 - 500 KB
Image resolution: -


Image URL: 

Specify the image for the banner.


Warning: Make sure that the image URL is publicly accessible.


Learn more about image banner use cases.
HTML banner

For HTML banners, the content of the banner needs to be specified manually (see the section for developers for technical details about how the banners are included in the page).


HTML:

The source code for the banner. 

The maximum length of the HTML code is 100 000 characters.


Learn more about HTML banner use cases.
General settings

Element ID (required)

ID of HTML element on a website where banner will be placed.

To learn more about how to set element ID on the website, please refer to developers documentation.


If there is already a content within Element ID- it will be exchanged by the embedded web banner. 


Remember: element ID should be unique on the website, as if more element Ids defined on the same page, SDK uses document.getElementById method for finding element by ID, it will find the first one in HTML document and place the banner there.


Warning: Meiro do not validate if element ID exist on the website, this must be tested and checked by the client on the websie. 


Banner width in pixels  (optional)

If not set banner width will be 100% of the element specified by ID.


 Remember: If multiple embedded web banners have the same priority, Element IDs and conditions the banner that has been displayed the least number of times during user's session will be shown. For example, in case of  3 banners A,B, C, each starting at 0 impressions: First page view, banner B will be selected (randomly), impression for banner B in current session is 1. Second page view, only banner A or banner C can be displayed as they have 0 impressions in current session, banner C will be randomly selected from these two, impression set to 1. Third page view in current session: only banner A has 0 impressions, will be displayed and impression set to 1. Fourth page view in current session, each banner has same impression set to 1 so the algorithm starts same again as in point 1 when all of them have 0 impressions.


Back to top