BOOMR .plugins. TPAnalytics

Captures session IDs and campaign information from third party analytic vendors installed on the same page.

Third party analytics vendors currently supported:

Google Analytics
Adobe Analytics (formerly Omniture Sitecatalyst)
IBM Digital Analytics (formerly Coremetrics)

Beacon Parameters

This plugin adds the following parameters to the beacon:

tp.ga.clientid: Google Analytics clientID (unique id per visitor)
tp.ga.utm_source: Google Analytics Campaign source
tp.ga.utm_medium: Google Analytics Campaign medium
tp.ga.utm_term: Google Analytics Campaign term
tp.ga.utm_content: Google Analytics Campaign content
tp.ga.utm_campaign: Google Analytics Campaign ID
tp.aa.aid: Adobe Analytics Analytics ID (AID)
tp.aa.mid: Adobe Analytics Marketing ID (MID)
tp.aa.campaign: Adobe Analytics Campaign ID
tp.aa.purchaseid: Adobe Analytics Purchase ID
tp.ia.coreid: IBM Analytics Core ID (unique id per visitor)
tp.ia.mmc_vendor: IBM Analytics Campaign vendor
tp.ia.mmc_category: IBM Analytics Campaign category
tp.ia.mmc_placement: IBM Analytics Campaign placement
tp.ia.mmc_item: IBM Analytics Campaign item
tp.ia.sp_type: IBM Analytics Site promotion type
tp.ia.sp_promotion: IBM Analytics Site promotion
tp.ia.sp_link: IBM Analytics Site promotion link
tp.ia.re_version: IBM Analytics Real estate version
tp.ia.re_pagearea: IBM Analytics Real estate page area
tp.ia.re_link: IBM Analytics Real estate link *

Methods

init(config)

Initializes the plugin.

Parameters:

Name Type Description

config

object

Configuration

Properties

Name	Type	Description
`TPAnalytics.clientids`	boolean	Whether or not to include client IDs.
`TPAnalytics.dropParams`	Array.<string>	Parameters to not include on the beacon.

Returns:

BOOMR.plugins.TPAnalytics The TPAnalytics plugin for chaining

Example

BOOMR.init({
  TPAnalytics: {
    clientids: false
  }
});

is_complete()

This plugin is always complete (ready to send a beacon)

Returns:

Type: boolean

true