You can install the package via composer:
composer require astrogoat/gtm
If you plan on using the flash-functionality you must install the GoogleTagManagerMiddleware, after the StartSession middleware:
// app/Http/Kernel.php
protected $middleware = [
...
\Illuminate\Session\Middleware\StartSession::class,
\Spatie\GoogleTagManager\GoogleTagManagerMiddleware::class,
...
];
This will require two includes to be added to BRAND/layout/app.blade.php
<head>
...
@include('gtm::header-script')
</head>
<body>
...
@include('gtm::body-script')
</body>
Your base dataLayer will also be rendered here. To add data, use the set()
function.
// HomeController.php
public function index()
{
GoogleTagManager::set('pageType', 'productDetail');
return view('home');
}
This renders:
<html>
<head>
<script>dataLayer = [{"pageType":"productDetail"}];</script>
<script>/* Google Tag Manager's script */</script>
<!-- ... -->
</head>
<!-- ... -->
</html>
The package can also set data to render on the next request. This is useful for setting data after an internal redirect.
// ContactController.php
public function getContact()
{
GoogleTagManager::set('pageType', 'contact');
return view('contact');
}
public function postContact()
{
// Do contact form stuff...
GoogleTagManager::flash('formResponse', 'success');
return redirect()->action('ContactController@getContact');
}
After a form submit, the following dataLayer will be parsed on the contact page:
<html>
<head>
<script>dataLayer = [{"pageType":"contact","formResponse":"success"}];</script>
<script>/* Google Tag Manager's script */</script>
<!-- ... -->
</head>
<!-- ... -->
</html>
// Retrieve your Google Tag Manager id
$id = GoogleTagManager::id(); // GTM-XXXXXX
// Check whether script rendering is enabled
$enabled = GoogleTagManager::isEnabled(); // true|false
// Add data to the data layer (automatically renders right before the tag manager script). Setting new values merges them with the previous ones. Set also supports dot notation.
GoogleTagManager::set(['foo' => 'bar']);
GoogleTagManager::set('baz', ['ho' => 'dor']);
GoogleTagManager::set('baz.ho', 'doorrrrr');
// [
// 'foo' => 'bar',
// 'baz' => ['ho' => 'doorrrrr']
// ]
composer test
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.