README.md

ga-module

A Nuxt.js tiny client-side module for tracking with Google Analytics

Setup

• Add daliborgogic/ga-module dependency using yarn or npm to your project
• Add daliborgogic/ga-module to modules section of nuxt.config.js

Replace UA-XXXXXXXX-X by your Google Analytics tracking ID.

{
  modules: [
    [ 'ga-module', { trackingID: 'UA-XXXXXXXX-X' }]
  ]
}

Voilà, Google Analytics is integrated into your Nuxt.js application and will track every page view!

For pageview hits only, if no params are provided, then the document.title and location.href values will be auto-filled. This allows you to send valid requests by writing:

ga.send('pageview') is the same as ga.send('pageview', { dt:document.title, dl:location.href })

API

ga(trackerID, options)

trackingID

Type: String

Your Google Analytics tracker ID; eg UA-XXXXXXXX-X

options.aip

Type: Integer
Default: 0

Anonymize the sender's IP address. See Anonymize IP.

options.an

Type: String

Specifies the application's name. See Application Name.

options.aid

Type: String

Specifies the application identifier. See Application ID.

options.aiid

Type: String

Specifies the application installer identifier. See Application Installer ID.

options.av

Type: String

Specifies the application verison. See Application Version.

options.ds

Type: String

Indicates the data source type of the hit; eg web or app. See Data Source.

ga.send(type, params)

type

Type: String
Default: pageview

The type of hit to send. Must be one of these: pageview, screenview, event, transaction, item, social, exception, or timing.

params

Type: Object

The parameters to send based on the type of hit.

Please follow the links for each available parameter set:

• Event
• Exception
• Item
• Pageview
• Screenview
• Social
• Timing
• Transaction

License

MIT