Basic Google Analytics web component with Do Not Track support.

[ This description is mirrored from README.md at github.com/justinribeiro/ga-dnt-analytics on 2019-05-22 ]

<ga-dnt-analytics>

Basic Google Analytics web component with Do Not Track support. Published on webcomponents.org

<ga-dnt-analytics debug="true"></ga-dnt-analytics>
ga-dnt-analytics - Open DevTools and check console.

image

Installation

Install the component using Bower:

bower i justinribeiro/ga-dnt-analytics --save

Usage

  1. Import Web Components' polyfill, if needed:

    <script src="bower_components/webcomponentsjs/webcomponents-loader.js"></script>
    
  2. Import ga-dnt-analytics:

    <link rel="import" href="bower_components/ga-dnt-analytics/ga-dnt-analytics.html"/>
    
  3. Start using it!

    <ga-dnt-analytics key="UA-XXXXXX-X"></ga-dnt-analytics>
    

Attributes/Properties

Attribute Options Default Description
key String "" (optional) Sets UA for Google Analytics tracking
debug Boolean false (optional) Enables Google Analytics debugging mode
trace Boolean false (optional) Use with debug; enables full tracing for GA
donottrack Boolean true (optional) Check and use Do Not Track browser flag
pageview Boolean false (optional) Send ga('send', 'pageview') ping on element stamp

Methods

If not using the pageview property to send a ping to GA, you can use the send() method to send a payload to GA.

// via Polymer 2.x
this.shadowRoot.querySelector('ga-dnt-analytics').send({
  hitType: 'pageview',
  page: window.location.pathname,
  location: window.location.href,
  title: 'My Title'
});

// via Polymer 1.x
this.$$('ga-dnt-analytics').send({
  hitType: 'pageview',
  page: window.location.pathname,
  location: window.location.href,
  title: 'My Title'
});

// via JavaScript
document.querySelector('ga-dnt-analytics').send({
  hitType: 'pageview',
  page: window.location.pathname,
  location: window.location.href,
  title: 'My Title'
});

For list of payloads and string/objects to send, see See https://developers.google.com/analytics/devguides/collection/analyticsjs/sending-hits.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Credits

Justin Ribeiro Schalk Neethling Google Analytics

License

MIT License (MIT)

Install

Link to this version
ImportedReleased 07 July 2017Other
Framework Support
Polymer 2.0+
Also supported:
Polymer 1 (0.0.1)
Browser Compatibility
Install with
Release notes - Version 2.0.1

Dependencies

Polymer/polymer#^2.0.0