Pop-up banners: create form & conditions

Prerequisites

To work with webon-site banners,personalization, 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/ Configurations/Settings tab. 

3. The Pop Pop-up web banners tab must be enabled by the administrator for your user role.

Name pop pop-up 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/ Pop Channels/Web/Pop-up web banners tab. 

Warning: Depending on the reporting set for measuring pop pop-up web bannersbanners' performance, changing of the name may influence the report e.g., reporting may be set to track various versions of pop pop-up 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

(required)

Select frequency cap per user for hour/ day/ 1 session and in total ("Total" number of the display is optional to define).

Ignore global frequency cap

The checkbox allows certain important pop pop-up web banners to bypass the global frequency cap setting and respect only their own frequency cap.

Remember: it is also possible to set global frequency for 1 user across all pop pop-up web banners. 

E.g., Above is an example of a setting with 10 views of a pop pop-up web banner in total and 1 per session per user. With the "Ignore global frequency cap" setting enabled, this pop pop-up web banner will display regardless of the global frequency cap.

Priority

(required)

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

The Meiro will only show one banner at a time to a user.

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, the banner which has been shown to this user the least number of times in the past 24 hours will be selected.

Display condition

The default condition is "Page load".

Show on: 

• Page load: the pop pop-up web banner will display when the page is loaded;
• Scroll: the pop pop-up web banner will appear when you scroll down to the specified percentage of the website, eg:e.g., 50% means the scrollbar is at the middle position;
• Exit (exit intention): the pop pop-up web banner will display when you are about to close the page or browser: e.g., moving outside the page, when closing the tab/ window, or changing the URL in the search bar.

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: local storage key, data type (boolean, string, number, datetime), depending on the data type setset, 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

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.

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: 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 MeiroMeiro's backend API to retrieve the client's IP address. In caseIf the backend API call fails, the banner will still be displayed.
• This situation should not normally occur under normal circumstances as the API call is designed as low-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 may still may notice events or reported activity from blocked IP addresses, though in negligible volumes.

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.

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.

Possible operators: name of GTM DL object, GTM DL path, data type (boolean, datetime, number, string), depending on the set datatypedatatype, 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:

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).

Possible operators: contains, doesn't contain, equals, doesn't equal, equals any of, doesn't equal 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.

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).

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

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:

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 pop pop-up 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 thisthese conditions: abandonnedabandoned basket, form with promo code.

Learn more about how to display web bannerbanners to segmented audience.

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

Select conditions for page views when the pop pop-up web banner will be triggered. All page views are counted within one session.

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.worldwide.

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.

Possible operators: equals, doesn't equal, equals any of, doesn't equal any of, contains any of, doesn't not 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.

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: 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.

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.

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)

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

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

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)

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

Template Gallery

Gallery with HTML templates allows users to create web banners with already prescribed HTML code. This feature enables customers to showcase their purchase intention, offer time-limited discounts, provide promo codes, and more, using various web banner templates.

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

Image banner

Image banners consist entirely of the specified image. After clicking on the pop pop-up web bannersbanners, the user is directed to the specified destination URL (the new page will open in the same window as the current page).

The banner has a close button in the top right corner automatically included.

The dimensions of the image banner are the same as the dimensions of the specified image, but they are scaled down if the window is too small:

• On mobile phones, the image is scaled down to fit the window, leaving a 20-pixel gap from each edge.
• On other devices, the image is scaled down so that the width is at most 50 % of the window width and the height at most 50 % of the window height.
• The aspect ratio is always preserved.

Destination URL: The URL that the user will be taken to after clicking on the banner.

Image upload:

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

Image URL: The URL of the image that will make up the banner.

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

HTML banner

For HTML banners, the content of the banner and the dimensions need 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.

Close button

Enable close button (for HTML only)

When enabled, the banner is displayeddisplayed, including the default close button in the top right corner.

If disabled, the developer would need tomust include the close button in the HTML code.

The Meiro SDK provides a method that can be called by this close button to close the banner (see the section for developers for more details).

Select colourscolors for the icon, background, and border of the close button.  

Default icon color #222222

Default background color #FFFFFF

Default border color #CCCCCC

General settings

Position

The position where the banner will be located on the page: top middle, top left, top right, middle, middle left, middle right, bottom middle,  bottom left, bottom right. It is possible to adjust the position by editing the displayed margins. Changes will be visible in the preview below. 

For the position “middle”, the page will be covered with a semi-transparent overlayoverlay, and the banner will be displayed on top of the overlay. If the user clicks anywhere outside of the banner, this will close the banner.

For the other positions, the banner will be displayed without an overlay and can only be closed by clicking the close button in the banner. These banners will be offset from the edge of the window by a 20-pixel gap.

Banner width in pixels

Insert banner width. The field is:

-

• optional for image- if no width is inserted, popa pop-up web banner will be displayed according to its size,

-

• mandatory for HTML pop pop-up webbanners.
banners.

If the pop pop-up web banner does not fit into the viewpoint, it will be responsive: 100% viewpoint width, 40 pixels of margins.

Animation

Available options: none, fade in, slide in.

Selected animation will be visible in the preview. 

Disable default tracking

The checkbox gives you the option to turn off the tracking of web bannerbanner's impressions, which is enabled by default.

Learn more: about the principle of disabling default tracking here.

Image upload:

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

Image URL: The URL of the image that will make up the banner.

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

HTML code: insert code for the minimized pop pop-up web banner. If HTML will beis set like form, the form will not be active, as clicking on the pop pop-up web banner opens a large pop pop-up web banner. 

Display minimized version first (image only)

Toggle to show a minimized pop pop-up web banner as first, after that large pop up web banner.one. 

Position

The position where the banner will be located on the page: top middle, top left, top right, middle, middle left, middle right, bottom middle,  bottom left, bottom right. It is possible to adjust the position by editing the displayed margins. Changes will be visible in the preview below. 

For the position “middle”, the page will be covered with a semi-transparent overlayoverlay, and the banner will be displayed on top of the overlay. If the user clicks anywhere outside of the banner, this will close the banner.

For the other positions, the banner will be displayed without an overlay and can only be closed by clicking the close button in the banner. These banners will be offset from the edge of the window by a 20-pixel gap.

Banner width in pixels

Insert banner width. Field is:

-optional for image- if no width is inserted, pop pop-up web banner will be displayed according to its size,

-mandatory for HTML pop pop-up web banners.

If the pop pop-up web banner does not fit into the viewpoint, it will be responsive: 100% viewpoint width, 40 pixels of margin.

Animation

Available options: none, fade in, slide in.

Selected animation will be visible in the preview. 

Enable the close button (for HTML only)

When enabled, the banner is displayeddisplayed, including the default close button in the top right corner.

If disabled, the developer would need to include a close button in the HTML code.

The Meiro SDK provides a method that can be called by this close button to close the banner (see the section for developers for more details).

Select colours for the icon, background, and border of the close button.  

Defualt icon color #222222

Default background color #FFFFFF

Default border color #CCCCCC

Available conditions: equals any, doesn't equal any, contains, doesn't contain any of 

Hide minimized pop pop-up web banners on URLs or multiple URLs. Currently minimized pop pop-up web bannersbanners, as soon as displayed, will follow the user until closed.