Skip to content

Latest commit

 

History

History
82 lines (51 loc) · 5.54 KB

README 1.1 (old release).md

File metadata and controls

82 lines (51 loc) · 5.54 KB
Raw

utm-alternative

This new project aim is to provide the ability to use campaign data values inside the DOM (such as in forms). Many of us in the past added campaign data to our CRM (such as Salesforce) with Google Analytics UTMZ cookies, but with the move to Universal Analytics (UA), it's not possible to retrieve UTMZ cookie values anymore, since Universal Analytics script does not store campaign data on a cookie. This project then 1) creates a new cookie, "traffic_source", which tracks the campaign data based on a fixed query string parameter, SRC (read more below) 2) Stores the existing UTMZ campaign value of returning users so old campaign data won't be lost.

The SRC value

Since not all analytics platforms employ the utm_campaign query string paraemter, and since the auto-tagging of adwords enables you to omit it, the most efficient way to track campaign is by using a new campaign query string paremeter: "src". Each time this parameter is declared in the URL, the utm-alternative cookie takes action.

How Does the Script Work?

  1. First, checks whether there is an existing UTMZ cookie with a campaign info. If there is one, it saves it to the new cookie - "traffic_source". (This name can be changed to something else)

  2. If there is also a SRC value, it adds it to the cookie (=concatenate it), unless it already exists as the recent value. This way you can track your campaigns effect over time.

  3. If there is neither, the script looks at the HTTP referrer, to see if it came from Google, Bing or Yahoo. If it does, it adds it to the cookie. If none of the search engine, it will add the exact referring path (www.example.com/page.html)

  4. Otherwise, put NONE (strictly speaking, we cannot know for sure it's "direct" traffic).

An example of how the traffic source value should look like:

{src value from linkedin campaign}>>{src value from adwords campaign}>>{utmz campaign value}

(>> Double arrow is the separator of the values)

As of version 1.1, you can add the time of session. Each source value will be concatenated with the date in the format:

>>{traffic source}|>DD-MM-YY HH:MM AM/PM>>

To activate it, you will need to uncomment the function and some lines in the code (instructions are within). If you do not wish to activate it, no other steps are required in order to use the code.

Installation

Pass your domain name (in the format: .YOURDOMAIN.com) in the closure of the function. You can also change the default cookie name "traffic_source" to something else if you would like to.

Loading the Javascript: The main javascript could be loaded in the head section, after the body tag, or via GoogleTagManager.

  1. If you run traffic_source.js in the head, the JS code that prints the value in the form (hereafter: form.html) should run after the body tag.
  2. If you run all JS after body tag, the traffic_source.js should run before form.html.
  3. If via GoogleTagManager, you must make sure that traffic_source.js runs before form.html. You can do that by putting both piece of codes in one tag, one after the other.

FAQ

Q: Why not with Local Storage but a cookie?
A: Local Storage does not allow you to share data across subdomains easily (if at all). Many advertisers run different campaigns on different web assets, so being unable to share this data across subdomains will make this script less effective.

Q: Why Javascript?
A: Cross-platform, server-side agnostic solution.

Q: What to do if I use the utm_campaign any way and I don't use Adwords auto-tagging?
A: From now on just add src=XXX to the target URL. You can make it identical to the utm_campaign so you keep track of your campaigns easily. The ability to rely on the utm_campaign query string parameter alone was considered, however to keep it flexible and to adjust to different implementations of different users, a new parameter was created. Nevertheless, if this use case will be more popular, an additional version that employs (or at least gives the option to rely on) the utm_campaign instead will be created. Read "Tagging URLs" file for more information on using the plugin.

Q: So is the UTMZ campaign value adds up to the cookie each time the user enters the site?
A: No. Once there is a new "traffic_source" cookie, the script does not check for utm_campaign anymore. You can now rely on the new traffic_source cookie.

Q: Do I must use Google Analytics?
A: The script works independently, so Google Analytics is not required. You can use it for your own projects where you need the campaign data in the DOM. However, it allows marketers who used Google Analytics UTMZ cookie to retain the campaign data accessible via a cookie.

Please Contribute!
This project is completely functional and working. However, it needs more use cases, testing and suggestions to improve it. Please do!
Updates

AUG 07 2015
Added notes for implementation "Tagging URLs.md"

FEB 22 2015
Change separators for easier data analysis.

JAN 30 2015
-Domain and cookie name values are passed to the function. If no domain name is passed, the function will take by default the hostname (-->including the subdomain). Thanks caiorogerio.
-Small fix of currTime() function.

Aug 25 2014
Release 1.1: New currTime() function gives you an option to add the time of the session to the traffic source cookie. By default, these lines are commented out.

Aug 15 2014
Add "utmz:" string before the old UTMZ campaign value (that was retrieved from the existing UTMZ cookie of the user).