@ngx-ext/google-analytics
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.1 • Public • Published

    @ngx-ext/google-analytics Build Status

    Google Analytics for your Angular application

    Install

    $ ng add @ngx-ext/google-analytics
    

    Usage

    Configuration

    The Google Analytics tracking script is included in this module.

    import { BrowserModule } from '@angular/platform-browser';
    import { NgModule } from '@angular/core';
    import { GoogleAnalyticsModule, GA_TOKEN } from '@ngx-ext/google-analytics';
    import { AppComponent } from './app.component';
    
    @NgModule({
    	imports: [
    		BrowserModule,
    		GoogleAnalyticsModule.forRoot()
    	],
    	declarations: [
    		AppComponent
    	],
    	bootstrap: [AppComponent],
    	providers: [
    		{ provide: GA_TOKEN, useValue: 'UA-TOKEN-1' } // or use GoogleAnalyticsService.configure(ga-token)
    	]
    })
    export class AppModule { }

    Service

    Inject the GoogleAnalyticsService into your components or services.

    import { Component, OnInit } from '@angular/core';
    import { GoogleAnalyticsService } from 'angular-ga';
    
    @Component({
    	templateUrl: 'app.component.html'
    })
    export class AppComponent implements OnInit {
    
    	constructor(
    		private gaService: GoogleAnalyticsService
    	) { }
    
    	ngOnInit() {
    		this.gaService.event.emit({
    			category: 'app',
    			action: 'bootstrap'
    		});
    	}
    }

    Configuration

    import { Component, OnInit } from '@angular/core';
    import { GoogleAnalyticsService } from 'angular-ga';
    
    @Component({
    	templateUrl: 'app.component.html'
    })
    export class AppComponent implements OnInit {
    
    	constructor(
    		private gaService: GoogleAnalyticsService
    	) { }
    
    	ngOnInit() {
    		this.gaService.configure('UA-TOKEN-1');
    	}
    }

    API

    service.configure(trackingId, [options])

    trackingId

    Type: string

    Tracking Id.

    options

    Type: Object string
    Default: auto

    Any of the Create Only Fields.

    service.event.emit(event: Event)

    Emit a Google Analytics event.

    event

    category

    Type: string

    Typically, the object that was interacted with (e.g. Video)

    action

    Type: string

    The type of interaction (e.g. play)

    label

    Optional
    Type: string

    Useful for categorizing events (e.g. Fall Campaign)

    value

    Optional
    Type: number

    A numeric value associated with the event (e.g. 42)

    service.pageView.emit(pageView: PageView)

    Emit a Google Analytics page view.

    PageView

    page

    Type: string

    The path portion of a URL. This value should start with a slash (/) character.

    title

    Optional
    Type: string

    The title of the page (e.g. homepage)

    Install

    npm i @ngx-ext/google-analytics

    DownloadsWeekly Downloads

    24

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    162 kB

    Total Files

    40

    Last publish

    Collaborators

    • danielkucal