Angular Web SDK Integration Guide

Feature Summary: The Kochava Angular Web SDK is a javascript-based solution that provides marketers with Web Tracking capabilities. It can be integrated with a variety of web-based frameworks; this document describes how to integrate with the Angular framework.

If you have already integrated the SDK and started it, please visit Using the SDK support page and choose a topic.

Integrating the SDK

Requirements:

NodeJS
NPM
Angular

Supported Platforms:

Angular

Data Privacy:

SDK Data Privacy and Safety

Integration:

Estimated Time to Complete

5 Minutes

(Release Notes)

The Kochava Web SDK is available as a first-class Angular library. The SDK itself operates as an Angular service singleton, available within the KochavaAngularModule.

Navigate to the root of your Angular project.
Run ng add kochava-angular>.
Run npm install kochava@latest>.
In your root component’s module file (typically app.module.ts) add the following:

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { KochavaAngularModule } from 'kochava-angular'; // import the module

import { AppComponent } from './app.component';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    KochavaAngularModule.forRoot() // call forRoot() on the module
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

Starting the SDK

Estimated Time to Complete

1 Minute

Once you have added the Kochava SDK to your project, the next step is to create and start the SDK class in code. Only your App GUID is required to start the SDK with the default settings, which is the case for typical integrations.

Kochava recommends starting the SDK as soon as the application starts, although this can be done later if needed. Starting the tracker as early as possible will ensure it has started before use, resulting in more accurate data/behavior.

In your root component (usually app.component.ts), import the KochavaAngularService and inject it into the constructor. Then call startWithAppGuid with your Kochava app guid.

import { Component } from '@angular/core';
import { KochavaAngularService } from 'kochava-angular'; // import the service

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.css'],
  providers: [
    KochavaAngularService // add the service as a provider
  ]
})
export class AppComponent {
  title = 'angular';

   // inject service in the constructor
   // you can call the service whatever you would like instead of 'kos'
  constructor(kos: KochavaAngularService) {

    // start the SDK 
    // replace YOUR_APP_GUID with your kochava app guid    
    kos.kochava.startWithAppGuid("YOUR_APP_GUID"); 
  }
}

Replace YOUR_APP_GUID> with your Kochava App GUID. For more information on locating your App GUID, refer to our Locating your App GUID support documentation.
For any additional components which use the SDK, import the KochavaAngularService and inject it as a dependency into the component’s constructor. No additional provider entries are required.

import { KochavaAngularService } from 'kochava-angular';
...
export class AppComponent {
 constructor(kos: KochavaAngularService) {
   kos.kochava.sendPageEvent("test_page"); // example of page
 }
}

Optional Configuration:

NOTE: These calls are optional and used for irregular SDK behavior. In most cases, you do not need to call these functions at all.

Disable automatic page events – Call this function with an argument of true to stop the SDK from automatically signaling a page event when the SDK starts.
Use cookie storage – Call this function with an argument of true to drop the Cookie on the website to track a device across sub-domains.

import { Component } from '@angular/core';
import { KochavaAngularService } from 'kochava-angular';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.css'],
  providers: [
    KochavaAngularService
  ]
})
export class AppComponent {
  title = 'angular';
  kos: KochavaAngularService;

  constructor(kos: KochavaAngularService) {
    this.kos = kos;

    // automatic page events will be sent out (default)
    this.kos.kochava.disableAutoPage(false);

    // automatic page events will not be sent out
    this.kos.kochava.disableAutoPage(true);

    // cookies will not be used for sdk storage (default)
    this.kos.kochava.useCookies(false);

    // cookies will be used for sdk storage
    this.kos.kochava.useCookies(true);

    this.kos.kochava.startWithAppGuid("kowebsdkv3-7pv0");
  }
}

Confirm the Integration

After integrating the SDK and adding the code to start the measurement client, launch and run the app for at least 10 seconds or more. During this time the client will start and send an install payload to Kochava. To confirm integration was successful, visit the app’s Install Feed Validation page Apps & Assets > Install Feed Validation. On this page you should see one of two integration messages, indicating integration success or failure.

Integration Successful:

Integration Success!

Along with this message you will also see a variety of data points associated with the device used for testing. At this point your integration is successful and you can proceed to the next step(s).

NOTE: It may take a few minutes for the first install to appear within the Install Feed Validation page. If you do not see this message immediately, you may simply need to wait a few minutes and check again.

Integration Not Complete:

Integration Not Complete!

If you encounter this message, please review the integration steps, uninstall and reinstall the app, and check again.

SDK WAYPOINT: At this point basic integration is complete and the Kochava SDK will begin reporting session activity and attributing installs.

Where to Go From Here:

Now that you have completed integration you are ready to utilize the many features offered by the Kochava SDK. Continue on to Using the SDK and choose a topic.

Angular Web SDK Integration