Banner Manager

Create artwork, choose its audience and schedule, publish it on your storefront, and review banner engagement.

Installation and prerequisites

Banner Manager requires the Magedia Core shared package (1.2 or later within major version 1), Magento’s Catalog Rule module, and a RequireJS storefront such as Luma. It runs on Magento Open Source 2.4.x with PHP 8.3–8.5, and has been exercised on 2.4.9 with PHP 8.4. Other PHP and Magento versions, and Hyvä/PWA storefronts, need separate validation.

Configure access to Magedia’s private Composer repository at repo.magedia.com using the credentials issued with your purchase, then install the package and enable the modules:

composer require magedia/m2-banner-manager
bin/magento module:enable Magedia_Core Magedia_BannerManager
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy
bin/magento cache:flush

Deploy static content for your store locales and follow your normal production deployment procedure. Configure Magento cron and a working email transport if you want campaign expiration reminders.

Open Stores > Configuration > Magedia > Banner Manager. Use the scope selector and inherited-value controls where available. Save Config, then refresh Magento's configuration cache when prompted.

Enable Banners (default Yes): the master switch for storefront banners. No stops banner markup and delivery requests in the selected scope, even if individual images and campaigns are active. This setting is available at default, website, and store-view scope.

Allow SVG Uploads (default No): permits sanitized SVG uploads when enabled. PNG, JPG, and GIF remain available without this option. This upload setting is global.

Record Displays and Clicks (default Yes): controls statistics collection. No keeps banners visible but stops recording new displays and clicks; existing statistics remain. This setting is available at default and website scope.

Maximum Tracked Events per Visitor (default 120): the global maximum accepted events from one visitor session during a 15-minute window. Displays and clicks count toward this limit. Automated traffic or repeated testing can reach the cap, after which additional events stop recording until the window resets.

Duplicate-Suppression Retention (hours) (default 24): how long delivery tokens are retained to suppress duplicate events. The hourly Magento cron removes expired suppression records. This global setting does not set the retention period for daily display and click totals. The event-limit and retention fields are shown when statistics recording is enabled.

1. Create an image

Open Magedia > Banner Manager > Image Storage and click Add New Banner. Enter a descriptive Title, such as Summer offer. The library grid lets you filter images and review their displays, clicks, and CTR.

In Preferences, choose the image Type and Status. Use Single for a normal banner, Single Full Width for a wide design, Left or Right for an aligned design, or Popup Banner for an overlay.

Direct URL is the HTTP or HTTPS destination when a customer clicks the image. Leave it blank for a non-clickable image. Choose Same tab or New tab. Add an Image description (alt text) for screen readers; a blank description falls back to the title.

Priority: higher values display first. Device Visibility: choose Both, Desktop, or Mobile. Customer group: leave the selection empty to include everyone, including guests. Selecting groups restricts the image to those groups. Lazy loading defers loading until the image is needed.

Banner Manager: 1. Create an image — 1. Create an image. Select the illustration to view it at full size.

2. Upload and preview artwork

In Visual attributes, upload the required Banner Image. A brand logo and badge are optional. Configure the available text, button text, corner text, and colors to suit your design.

PNG, JPG, and GIF uploads are supported by default, up to 10 MB. SVG uploads are disabled by default. Enable Allow SVG Uploads in the extension configuration only when vector artwork is needed. Accepted SVG files are sanitized, but SVG remains an active content format. Very large raster images may be rejected. Size warnings do not remove an accepted upload; choose artwork appropriate for its placement.

Enable image optimization and open Image Optimization to compare originals with optimized files. Optimize each uploaded image as needed. PNG and JPG optimization can resize and compress artwork; SVG is sanitized and GIF animation is preserved. Removing an optimized copy leaves the original available.

Open Preview and switch between Desktop and Mobile. Preview uses the current unsaved design and does not record displays or clicks. Audience rules, schedules, and popup timers are checked on the storefront. Click Update to save the image.

Banner Manager: 2. Upload and preview artwork — 2. Upload and preview artwork. Select the illustration to view it at full size.

3. Create and schedule a campaign

Open Magedia > Banner Manager > Banners. Choose Regular Banner or Promo Banner and click Manage Banner. Enter a campaign Title and keep Status inactive while preparing it.

Start Date (UTC) is the instant the campaign becomes eligible to appear. End Date (UTC) is the end of its availability. Enter UTC time, converting from your local timezone where necessary. A blank start has no lower time limit; a blank end has no expiry.

To receive an expiration reminder, select the notification checkbox, enter a valid Email, and set an End Date. Magento's hourly cron checks for active campaigns ending within three days and sends one reminder. Changing the end date, recipient, or notification option resets that reminder state.

Banner Manager: 3. Create and schedule a campaign — 3. Create and schedule a campaign. Select the illustration to view it at full size.

4. Choose pages, stores, and images

In Display, choose the Layout Position: Top, Center, or Bottom. Choose All pages, or Specific Pages. For specific CMS pages, categories, or products, type into the corresponding search field and select the matching results. Repeat to add more targets; remove a selected item to stop targeting it. These controls search for items rather than showing a full catalog list. Select Store Views; an empty selection includes all storefront views.

In Banners, select one or more images from Image Storage. Only active images that match the customer's group and device can appear. Set the campaign Status to Active and click Update when ready.

Active campaigns cannot share a position when their store views, schedules, and page targets overlap. If Magento reports a conflict, change the position, narrow the targeting, adjust the dates, or deactivate the competing campaign. Inactive drafts may overlap.

The campaign grid's duplicate action creates an inactive draft. Review its title, dates, audience, and artwork before activating it.

Banner Manager: 4. Choose pages, stores, and images — 4. Choose pages, stores, and images. Select the illustration to view it at full size.

Promo Banner campaigns use the Center position and an active Catalog Price Rule. The rule must apply to the current website, customer group, and date, and match the viewed product or a visible cart product. This setting does not use Cart Price Rules or arbitrary cart subtotal conditions.

For an overlay, choose Popup Banner on the image. Set centered or fullscreen display and its dimensions. Add that image to a campaign with the intended page targeting.

Automatic closing controls when the overlay closes itself; Never leaves it open until a permitted customer action. Customer closing controls whether closing is available immediately, after a delay, or never. If customer closing is disabled, automatic closing must be enabled.

Automatic reopening controls the delay before a closed popup can appear again. Never suppresses reopening for the browser session. Test in a fresh browser session when checking this setting. Escape follows the same customer-closing permission as the close button.

6. Check the storefront

Open a targeted storefront page and confirm the placement, image, destination, and text. Check both desktop and mobile widths and test logged-out visitors as well as the selected customer groups. Confirm that the campaign's dates and store view include the page you are testing.

If a banner is missing, check Enable Banners in Stores > Configuration > Magedia > Banner Manager and the campaign and image statuses first, then selected images, UTC dates, store views, page targets, device visibility, and customer groups. For a promotion, also check the Catalog Price Rule and matching product context.

Banner Manager: 6. Check the storefront — 6. Check the storefront. Select the illustration to view it at full size.

7. Review statistics

Open Magedia > Banner Manager > Statistics. Select one image or all images, then choose Period from and Period to. Dates are inclusive in UTC; a report period can cover up to 366 days. Apply the filters to see daily displays and clicks, totals, and CTR. CSV export uses the same filters.

CTR is clicks divided by displays, multiplied by 100. It is zero when there are no displays. These are banner interaction counts, not unique visitors, orders, or revenue. Image Storage shows all-time image totals; a filtered report may show different totals.

A regular banner records a display when at least a quarter of it becomes visible; a popup records a display when it opens. Preview does not count. Repeated tracking messages for the same delivery are suppressed.

By default, collection is limited to 120 display/click events per visitor session per 15 minutes. If repeated testing stops increasing the totals, check Record Displays and Clicks and the event limit in configuration, then allow the current window to reset.

Historical click data: an earlier implementation did not record clicks because of a tracking defect. Click counts and CTR for periods affected by that defect should be treated as missing data, not evidence that customers did not click. Installing the corrected implementation enables future click recording; it cannot reconstruct earlier clicks. If you upgraded from the affected implementation, identify the correction deployment date before comparing campaign results.

Banner Manager: 7. Review statistics — 7. Review statistics. Select the illustration to view it at full size.

Maintain and troubleshoot campaigns

Deactivate a campaign to stop displaying it. A campaign can only be deleted while inactive. An image must be inactive and removed from all referencing campaigns before deletion. Deleting a record retains its media files to avoid breaking shared assets.

If reminders are missing, check the notification option, end date, recipient, Magento cron, and email transport. If menus are missing or Magento reports an invalid Magedia Core parent, check that Core is installed and enabled, run setup upgrade, and clean configuration and layout caches.

After extension or theme asset changes, deploy static content for the correct locales and refresh the browser. If an administrator sees a read-only editor, review their role permissions. Contact [email protected] with reproduction steps, the installed extension and Magento/PHP versions, and sanitized error details.