Feature Summary: The Kochava 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.

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

Integrating the SDK

Requirements:

• Google Tag Manager

Supported Platforms:

• Web (Browser)

Data Privacy:

• SDK Data Privacy and Safety

Integration

Estimated Time to Complete

5 Minutes

(Release Notes)

Follow the steps below to integrate the Kochava Web SDK using Google Tag Manager:

1. In the Google Tag Manager UI, click Add a new tag.
2. Click Tag Configuration.
3. Choose Tag Type > Custom > Custom HTML.

 



 

4. Prepare the SDK script:

<script>function loadScript() {
  if (window.kochava) {
    console.log("Kochava snippet already included");
    return
  }

  var scriptURL = "https://storage.googleapis.com/kochava-web-assets/kochava.js/v3/kochava.min.js";
  var kochavaScript = document.createElement("script");
  kochavaScript.type = "text/javascript";


  // To disable caching, change this value to true
  var disableCaching = false;

  kochavaScript.src =
    (disableCaching) ? scriptURL + "?c=" + Math.random() : scriptURL;
  kochavaScript.async = true;

  kochavaScript.onload = function() {
    // YOUR CODE HERE
  };
  document.head.appendChild(kochavaScript);
}

loadScript();</script>

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 is started before use, resulting in more accurate data/behavior.

Where your web page starts:

1. (Optional) Make any desired pre-start configuration calls (registerIdentityLink, disableAutoPage, useCookies etc).
2. Call startWithAppGuid using a valid Kochava App GUID.

Edit the snippet you included earlier to the following:

<script>function loadScript() {
  if (window.kochava) {
    console.log("Kochava snippet already included");
    return
  }

  var scriptURL = "https://storage.googleapis.com/kochava-web-assets/kochava.js/v3/kochava.min.js";
  var kochavaScript = document.createElement("script");
  kochavaScript.type = "text/javascript";


  // To disable caching, change this value to true
  var disableCaching = false;

  kochavaScript.src =
    (disableCaching) ? scriptURL + "?c=" + Math.random() : scriptURL;
  kochavaScript.async = true;

  kochavaScript.onload = function() {
    // YOUR CODE HERE
     window.kochava.startWithAppGuid("YOUR_APP_GUID");
  };
  document.head.appendChild(kochavaScript);
}

loadScript();</script>

Optional Configuration

From here on, the SDK is integrated and ready, the following configuration calls are optional, and are only for special desired SDK behavior. The following code snippets should be placed at in the above snippet, at the comment labeled Optional pre-start calls will go here.

<script>function loadScript() {
  if (window.kochava) {
    console.log("Kochava snippet already included");
    return
  }

  var scriptURL = "https://storage.googleapis.com/kochava-web-assets/kochava.js/v3/kochava.min.js";
  var kochavaScript = document.createElement("script");
  kochavaScript.type = "text/javascript";


  // To disable caching, change this value to true
  var disableCaching = false;

  kochavaScript.src =
    (disableCaching) ? scriptURL + "?c=" + Math.random() : scriptURL;
  kochavaScript.async = true;

  kochavaScript.onload = function() {
     // Auto pages will be sent (default)
    window.kochava.disableAutoPage(false);


    // Auto pages will not be sent
    window.kochava.disableAutoPage(true);

     window.kochava.startWithAppGuid("YOUR_APP_GUID");
  };
  document.head.appendChild(kochavaScript);
}

loadScript();</script>

<script>function loadScript() {
  if (window.kochava) {
    console.log("Kochava snippet already included");
    return
  }

  var scriptURL = "https://storage.googleapis.com/kochava-web-assets/kochava.js/v3/kochava.min.js";
  var kochavaScript = document.createElement("script");
  kochavaScript.type = "text/javascript";


  // To disable caching, change this value to true
  var disableCaching = false;

  kochavaScript.src =
    (disableCaching) ? scriptURL + "?c=" + Math.random() : scriptURL;
  kochavaScript.async = true;

  kochavaScript.onload = function() {
     // Will not use cookies (default)
    window.kochava.useCookies(false);


    // Will use cookies
    window.kochava.useCookies(true);


     window.kochava.startWithAppGuid("YOUR_APP_GUID");
  };
  document.head.appendChild(kochavaScript);
}

loadScript();</script>

<script>function loadScript() {
  if (window.kochava) {
    console.log("Kochava snippet already included");
    return
  }

  var scriptURL = "https://storage.googleapis.com/kochava-web-assets/kochava.js/v3/kochava.min.js";
  var kochavaScript = document.createElement("script");
  kochavaScript.type = "text/javascript";


  // To disable caching, change this value to true
  var disableCaching = true;

  kochavaScript.src =
    (disableCaching) ? scriptURL + "?c=" + Math.random() : scriptURL;
  kochavaScript.async = true;

  kochavaScript.onload = function() {
     window.kochava.startWithAppGuid("YOUR_APP_GUID");
  };
  document.head.appendChild(kochavaScript);
}

loadScript();</script>

Finish Tag Integration

1. Paste the snippet into the Tag Configuration.
2. Click on the Triggering panel.
3. Select Choose a trigger > All Pages.
4. Enter a name for the tag.
5. Click Save.

NOTE: The tag that was just created as well as all of other previously created tags may be viewed in the Tags section.

6. Publish the new changes by clicking on Submit in the upper right corner of the screen.
7. Enter the corresponding information in the version change fields.

 



 

8. Click Publish.

NOTE: With your new tag set up, you can now use the Kochava Web SDK by integrating GTM into your site. Instructions on how to do so can be found here.

Confirm the Integration

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.