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.
| Tool | Function | Required permissions (ACL) |
|---|---|---|
get_banners_status | Overview: options, banners by status, expired banners or banners that have reached their limit, published Banners modules | Admin access — core.manage |
list_banners | List banners with impressions, limits, clicks and click-through rates | Admin access — core.manage |
get_banner | Read a banner, including the tracking actually applied | Admin access — core.manage |
create_banner | Create an image or custom banner | Admin access + Create in the category — core.manage + core.create |
update_banner | Update a banner (only the fields provided are changed) | Admin access + Edit — core.manage + core.edit (or core.edit.own for its author) |
set_banner_state | Publish, unpublish, archive, move to the bin or pin | Admin access + Edit State — core.manage + core.edit.state |
delete_banners | Permanently delete banners moved to the bin | Admin access + Delete — core.manage + core.delete |
Statistics
Track campaign delivery and effectiveness.
| Tool | Function | Required permissions (ACL) |
|---|---|---|
get_banner_stats | Impressions and clicks by day, by month or in total, by banner, client or category | Admin access — core.manage |
reset_banner_stats | Reset impression and click counters, and optionally the history | Admin 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.
| Tool | Function | Required permissions (ACL) |
|---|---|---|
list_banner_clients | List clients, with their banners and totals | Admin access — core.manage |
create_banner_client | Create an advertiser client | Admin access + Create — core.manage + core.create |
update_banner_client | Update a client | Admin access + Edit — core.manage + core.edit |
list_banner_categories | List banner categories | Admin access — core.manage |
create_banner_category | Create a banner category | Admin access + Create — core.manage + core.create |
Good to know
- A banner is only displayed where a Banners module is published:
get_banners_statuslists 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.”