cybercog/yii2-google-analytics

Google Analytics Universal tracking widget.

Yii2 Google Analytics Tracking

This extension provides easy way to add Universal Analytics tracking in your Yii2 application.

Installation

The preferred way to install this extension is through composer.

Run in console

php composer.phar require cybercog/yii2-google-analytics

Usage

In your /views/layouts/main.php add

use cybercog\yii\googleanalytics\widgets\GATracking;

Then before </head> add following code

<?= GATracking::widget([
    'trackingId' => 'UA-XXXXXXXX-X',
]) ?>

Advanced usage

Omit script tag

By default this script generated output:

<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
	(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
	m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-XXXXXXXX-X', "auto");
ga('send', 'pageview');
ga('set', 'anonymizeIp', true);
</script>

But sometimes we need the output without script tag to combined with registerJs or registerJsFile as renderPartial to add dependency or positioning configuration, you can use omitScriptTag true to disable script tag, example:

<?= $this->registerJs(
    GATracking::widget([
        'trackingId' => 'UA-XXXXXXXX-X',
        'omitScriptTag' => true,
    ]), \yii\web\View::POS_END
); ?>

Example of advanced usage

You can configure tracking script for your needs:

<?= GATracking::widget([
    'trackingId' => 'UA-XXXXXXXX-X',
    'trackingConfig' => [
        'name' => 'myTracker',
        'allowAnchor' => false,
    ],
    'omitScriptTag' => false,
    'debug' => true,
    'debugTrace' => true,
    'anonymizeIp' => true,
    'plugins' => [
        'linkid' => [
            'cookieName' => '_ccli',
            'duration' => 45,
            'levels' => 5,
        ],
    ],
]) ?>

Available fields (parameters)

Field Name	Value Type	Default Value
anonymizeIp	boolean	true
debug	boolean	false
debugTrace	boolean	false

Official field reference

Available plugins

linkid (Enhanced Link Attribution)

Option Name	Default Value	Description
cookieName	_gali	Cookie name
duration	30	Cookie duration (seconds)
levels	3	Max DOM levels from link to look for element ID

Creating your own plugins

yii2-google-analytics's Issues

Alternative Asynchronous Snippet

While the canonical analytics.js snippet described above ensures the script will be loaded and executed asynchronously on all browsers, it has the disadvantage of not allowing modern browsers to preload the script.

The alternative snippet below adds support for preloading, which will provide a small performance boost on modern browsers, but can degrade to synchronous loading and execution on IE 9 and older mobile browsers which do not recognize the async attribute. We suggest you use this snippet if your visitors primarily use modern browsers to access your site.

<!-- Google Analytics -->
<script async src='//www.google-analytics.com/analytics.js'></script>
<script>
window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
ga('create', 'UA-XXXX-Y', 'auto');
ga('send', 'pageview');
</script>
<!-- End Google Analytics -->

Testing on localhost

In some cases you might want to test analytics.js from a webserver running on localhost. To set analytics.js cookies, you need to disable the default cookie domain using:

ga('create', 'UA-XXXX-Y', {
  'cookieDomain': 'none'
});

Renaming the Global Object

In some cases the ga variable name might already be used by an existing object on your page. To avoid overriding your existing object, you can rename the ga function, for example to __gaTracker. To do this, simply replace the ga parameter in the snippet above:

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','__gaTracker');

Add tracking object configuration

GA object creation documentation

Add GA plugins support

GA plugins description
Enhanced Link Attribution plugin
Customizing Enhanced Link Attribution

Add debugging

Documentation

Debugging

You can enable the debug version of analytics.js by using analytics_debug.js:

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics_debug.js','ga');
ga('create', 'UA-XXXX-Y', 'auto');
ga('send', 'pageview');

This should only be used temporarily or during development, as analytics_debug.js is larger and will delay hits to google-analytics.com.
Trace Debugging

Trace debugging will output more verbose information to the console. To enabled trace debugging, use https://www.google-analytics.com/analytics_debug.js and this line of code before the snippet.

window.ga_debug = {trace: true};

Collect list of all available parameters

Need to create a list of all available parameters and their examples for Universal Google Analytics to add implement them later.

add 0.1.1 or 0.2.0 tag

Could you add a tag for the latest change (additional attribute).
0.1.1 would be fine with semver.