API Reference

Complete reference for the window.TrafficCampaign API and the digitalData schema.

Methods

getDigitalData()

const data = TrafficCampaign.getDigitalData();

// Returns:
{
  trafficDetail: {
    source: "google",
    medium: "cpc",
    campaign: "spring_sale",
    channel: "Paid Search",
    provider: "googleAds"
  },
  campaigns: {
    campaignProvider: {
      provider: "googleAds",
      parameter: "gclid",
      value: "abc123..."
    },
    isCampaign: true
  },
  params: {
    utm_source: "google",
    utm_medium: "cpc",
    gclid: "abc123..."
  }
}

sendToGA(measurementId)

// Pushes campaign data to Google Analytics 4
TrafficCampaign.sendToGA('G-XXXXXXXXXX');

// This fires:
gtag('event', 'campaign_detected', {
  traffic_source: "google",
  traffic_medium: "cpc",
  send_to: 'G-XXXXXXXXXX'
});

Events

// Listen for when digitalData is ready
window.addEventListener('trafficcampaign:ready', (e) => {
  const digitalData = e.detail;
  console.log('Source:', digitalData.trafficDetail.source);
  console.log('Channel:', digitalData.trafficDetail.channel);
});

Window Globals

digitalData Schema

The SDK follows the Event-Driven Data Layer (EDDL) pattern. The digitalData object is vendor-agnostic and can be consumed by any analytics tool (GA4, Adobe, Piwik, etc).

trafficDetail

Supported Ad Platforms (60+)

Deep Dive