Skip to main content

Banners

The Banners plugin manages the banners, advertisers and categories of Joomla’s Banners component, and provides impression and click statistics.


These tools concern the Banners component (com_banners). They are only made available to the assistant if this component is enabled on the site: it is often disabled by default, so enable it under System → Manage → Extensions if necessary. Every action requires access to the banner manager (core.manage), as in the administration area, in addition to the permission shown in the “Required permissions” column. For banners, permissions are checked against their category.

Banners

Create and maintain banners: images or custom code, links, clients, impression limits and publishing dates.

ToolFunctionRequired permissions (ACL)
get_banners_statusOverview: options, banners by status, expired banners or banners that have reached their limit, published Banners modulesAdmin access — core.manage
list_bannersList banners with impressions, limits, clicks and click-through ratesAdmin access — core.manage
get_bannerRead a banner, including the tracking actually appliedAdmin access — core.manage
create_bannerCreate an image or custom bannerAdmin access + Create in the category — core.manage + core.create
update_bannerUpdate a banner (only the fields provided are changed)Admin access + Edit — core.manage + core.edit (or core.edit.own for its author)
set_banner_statePublish, unpublish, archive, move to the bin or pinAdmin access + Edit State — core.manage + core.edit.state
delete_bannersPermanently delete banners moved to the binAdmin access + Delete — core.manage + core.delete

Statistics

Track campaign delivery and effectiveness.

ToolFunctionRequired permissions (ACL)
get_banner_statsImpressions and clicks by day, by month or in total, by banner, client or categoryAdmin access — core.manage
reset_banner_statsReset impression and click counters, and optionally the historyAdmin access + Edit — core.manage + core.edit

Detailed statistics only count what Joomla has recorded: impression and click tracking is configured per banner, then per client, and finally in the component options. The get_banner_stats response identifies banners for which tracking is disabled.

Clients and categories

Manage advertisers and organise campaigns.

ToolFunctionRequired permissions (ACL)
list_banner_clientsList clients, with their banners and totalsAdmin access — core.manage
create_banner_clientCreate an advertiser clientAdmin access + Create — core.manage + core.create
update_banner_clientUpdate a clientAdmin access + Edit — core.manage + core.edit
list_banner_categoriesList banner categoriesAdmin access — core.manage
create_banner_categoryCreate a banner categoryAdmin access + Create — core.manage + core.create

Good to know

  • A banner is only displayed where a Banners module is published: get_banners_status lists them and warns you if there are none.
  • A banner's custom code is inserted as-is into pages. For security reasons, it is only accepted for users authorised to publish unfiltered HTML (global configuration text filters); others should use an image banner.
  • Start and end dates for banner display use the site's time zone.
  • Permanent deletion and resetting statistics take place in two stages: a preview first, followed by execution once you have approved it.
  • Creations, updates, state changes and deletions appear in Joomla's action log.

Prompt examples

“Which banners received the most clicks last month?”

“Create a banner for the spring promotion using the image images/banners/printemps.jpg, displayed until 30 April, for the client Garage Martin.”