Download the PHP package solidwork/contao-solid-ads-tracker-bundle without Composer

Contao Solid Ads Tracker Bundle

A Contao 5.3 bundle for automatically tracking visitors who arrive via Google Ads (gclid) or Bing Ads (msclkid).

Features

• Automatic detection of Google Ads clicks (gclid) and Bing Ads clicks (msclkid)
• Stores all hits in a dedicated database table (tl_solid_ads_visit)
• Records all UTM parameters (utm_source, utm_medium, utm_campaign, utm_term, utm_content)
• Backend module under System → Ads Tracker for reviewing all tracked visits
• Date range filter (From / To) with live entry count display
• Dropdown filters by source (Google / Bing), UTM Source, Medium and Campaign
• Full-text search across URL, Click-IDs, UTM parameters, referrer and user agent
• Detail view per entry with all stored fields
• Export filtered data as CSV or JSON (filename includes date, time and active filters)
• Installable via Contao Manager

Installation

Via Contao Manager (recommended)

1. Open Contao Manager
2. Search for solidwork/contao-solid-ads-tracker-bundle
3. Install and update the database
4. Run the required setup via SSH (see section below)

Via Composer

Then create the database table:

⚠️ Required: One-Time Setup

This step is mandatory. Without it, tracking will not work on production Contao installations that use the built-in HTTP cache.

Run the included setup command once after installation:

This command automatically:

1. Adds QUERY_PARAMS_REMOVE_FROM_DENY_LIST=gclid,msclkid to your .env.local
2. Clears the HTTP cache directory (var/cache/prod/http_cache/)

Why this is needed

Contao's built-in HTTP cache (ContaoCache) normalizes URLs before checking the cache. By default, it strips tracking parameters like gclid and msclkid:

• A request for /?gclid=test9999 is normalized to /?
• If /? is already cached, the full page is served from cache without the inner application ever seeing the gclid
• The tracking listener never fires for the original visitor request

The env variable QUERY_PARAMS_REMOVE_FROM_DENY_LIST=gclid,msclkid prevents this stripping, so each ad click URL gets its own cache entry and the tracking listener is called correctly.

Manual alternative: If you prefer, add QUERY_PARAMS_REMOVE_FROM_DENY_LIST=gclid,msclkid to .env.local by hand, then run rm -rf var/cache/prod/http_cache/ && php bin/console cache:clear.

Console Commands

Run setup (required once)

Configures .env.local and clears the HTTP cache:

Run database migration

After installation, create the table:

Load demo entries

To test the backend view with sample data:

Creates 10 realistic demo entries (Google Ads & Bing Ads) spread over 60 days. Visible in the Contao backend under System → Ads Tracker afterwards.

Backend Module

The module appears in the Contao backend under System → Ads Tracker.

List View

Displays all tracked visits with the following columns:

Date Range Filter

A date range (From / To) can be entered in the top panel. After clicking Apply, the list is restricted to that period. The current entry count is displayed next to the filter:

• Without filter: 13 entries total
• With filter: 3 of 13 entries

Dropdown Filters

Filter by the following fields via dropdown:

• Source – Google Ads or Bing Ads
• UTM Source
• UTM Medium
• UTM Campaign

Search

Full-text search across the following fields:

• Visited URL
• Google Click-ID (gclid)
• Bing Click-ID (msclkid)
• UTM parameters
• Referrer
• Browser / User-Agent

Detail View

Clicking the info icon opens the detail view with all stored fields for that entry.

Export

Use the Export CSV and Export JSON buttons to download all currently filtered entries. The export respects all active filters:

• Date range filter (From / To)
• Dropdown filters (Source, UTM Source, UTM Medium, UTM Campaign)

The filename automatically includes the date, time and active filters, e.g.:

How Does Tracking Work?

The bundle registers a Symfony event listener on kernel.request (priority 8). On every GET request it checks for a gclid (Google Ads) or msclkid (Bing Ads) parameter in $_GET. If found, the visit is immediately saved to the database.

AJAX requests are ignored. If an error occurs (e.g. table not yet created), the listener fails silently without affecting the page.

Contao HTTP Cache compatibility

Contao uses a built-in HTTP cache (ContaoCache) in production. Without the QUERY_PARAMS_REMOVE_FROM_DENY_LIST configuration described above, the tracking listener will never be called for ad clicks because:

1. Contao strips gclid/msclkid from the URL to create a normalised cache key
2. The normalised URL (e.g. /?) likely exists in cache → the cached response is returned directly
3. The inner Symfony application (and therefore this listener) is never invoked

With the env variable set, each gclid/msclkid URL gets its own cache entry and the full request reaches the tracking listener correctly.

Database Structure (tl_solid_ads_visit)

Requirements

• PHP 8.1 or higher
• Contao 5.3 or higher

License

LGPL-3.0-or-later – see LICENSE

Author

Solidwork