Getting Started

Minimal Setup

Installation (if still needed for legacy projects):
```
composer require spatie/laravel4-googletagmanager
```
Note: This package is abandoned and only works with Laravel 4. For new projects, use spatie/laravel-googletagmanager for Laravel 5+.

Publish Config:

php artisan config:publish spatie/googletagmanager

Update .env with your GTM ID:

GTM_ID=GTM-XXXXXX

Add to Layout: In your master Blade template (e.g., resources/views/layouts/app.blade.php), include the GTM snippet:
```
@include('googletagmanager::gtm')
```

First Use Case: Push a basic event to the dataLayer in a controller or service:

use Spatie\GoogleTagManager\GoogleTagManager;

GoogleTagManager::push([
    'event' => 'page_view',
    'page' => 'home',
]);

Implementation Patterns

Core Workflows

Data Layer Management:

Push structured data to dataLayer for GTM triggers:

// Track a custom event
GoogleTagManager::push([
    'event' => 'product_view',
    'product_id' => $product->id,
    'price' => $product->price,
]);

Use helper methods for common events:

GoogleTagManager::trackPageView('/products/123');
GoogleTagManager::trackEvent('checkout_started', ['value' => 99.99]);

Conditional Loading: Disable GTM in specific environments (e.g., staging) via config:
```
// config/googletagmanager.php
'enabled' => env('APP_ENV') !== 'staging',
```

Dynamic Data Injection: Attach user or session data to every page view:

// In a middleware or service provider
GoogleTagManager::push([
    'user_id' => auth()->id(),
    'user_email' => auth()->user()->email,
]);

E-Commerce Tracking: Use the package’s built-in e-commerce helpers:

GoogleTagManager::trackEcommercePurchase([
    'transaction_id' => 'T12345',
    'affiliation' => 'Summer Sale',
    'revenue' => '35.99',
    'tax' => '3.19',
    'shipping' => '5.00',
    'products' => [
        ['name' => 'Widget', 'id' => 'P123', 'price' => '19.99', 'quantity' => 1],
    ],
]);

Blade Directives: Push data directly in Blade templates:

@gtmPush({
    'event': 'video_play',
    'video_id': '{{ $video->id }}',
    'duration': '{{ $video->duration }}'
})

Gotchas and Tips

Pitfalls

Laravel 4 Only:
- This package will not work with Laravel 5+. Use spatie/laravel-googletagmanager instead.
- If migrating from Laravel 4, manually extract the GTM logic or rewrite using the newer package.
Data Layer Timing:
- Ensure dataLayer pushes occur before the GTM snippet loads. In Blade, place @include('googletagmanager::gtm') at the end of <body> and push data earlier in the template.
Caching Issues:
- If GTM events aren’t firing, clear Laravel’s view cache:
```
php artisan view:clear
```

Environment-Specific IDs:

Avoid hardcoding GTM IDs in Blade. Use the config:

<!-- Wrong: -->
<script>dataLayer = [{'gtm.id': 'GTM-XXXXXX'}];</script>

<!-- Correct: -->
@include('googletagmanager::gtm')

Debugging

Verify dataLayer: Inspect the browser console to confirm data is being pushed:

console.log(window.dataLayer);

Expected output:

[
    {"event":"page_view","page":"home"},
    {"event":"product_view","product_id":123}
]

GTM Preview Mode: Use GTM’s Preview Mode to test events without publishing.

Log Missing Events: Add a middleware to log dataLayer pushes for debugging:

// app/Http/Middleware/LogGtmEvents.php
public function handle($request, Closure $next) {
    if (GoogleTagManager::hasPushedData()) {
        Log::debug('GTM Events:', GoogleTagManager::getPushedData());
    }
    return $next($request);
}

Extension Points

Custom Data Layer Initialization: Override the default dataLayer initialization in app/Providers/AppServiceProvider.php:

public function boot() {
    GoogleTagManager::initialize([
        'dataLayer' => ['custom' => 'value'],
    ]);
}

Event Macros: Extend the package with custom event types:

// app/Providers/GoogleTagManagerServiceProvider.php
public function boot() {
    GoogleTagManager::macro('trackFormSubmit', function ($formName, $data = []) {
        $this->push(array_merge([
            'event' => 'form_submit',
            'form' => $formName,
        ], $data));
    });
}

Usage:

GoogleTagManager::trackFormSubmit('contact', ['success' => true]);

Async Loading: For better performance, load GTM asynchronously:

<!-- resources/views/layouts/app.blade.php -->
@if(config('googletagmanager.enabled'))
    <noscript><iframe src="//www.googletagmanager.com/ns.html?id={{ config('googletagmanager.id') }}"
      height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
      new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
      j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
      'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
      })(window,document,'script','dataLayer','{{ config('googletagmanager.id') }}');</script>
@endif

Laravel4 Googletagmanager Laravel Package