Last active
February 12, 2019 11:02
-
-
Save Jamiewarb/13a2ce807cfa83a8d95ac005421b0508 to your computer and use it in GitHub Desktop.
Vue Decorator Component for analytics tracking of non-vue button clicks
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* ~/helpers/analytics.js | |
* | |
* This is an example of an analytics helper that takes the guess work out of analytics tracking | |
* to multiple platforms. It will define the strategy for a particular event (Leads just to FB, clicks to GA, etc) | |
* by defining the event as the method, and then just off the necessary events itself. | |
*/ | |
import Vue from 'vue'; | |
export function toggleCanTrack($toggle) { | |
if ($toggle) { | |
Vue.$ga.enable(); | |
Vue.analytics.fbq.query('consent', 'grant'); | |
} else { | |
Vue.$ga.disable(); | |
Vue.analytics.fbq.query('consent', 'revoke'); | |
} | |
} | |
/** | |
* Track a GA event with the analytics platform. | |
*/ | |
export function trackGaEvent(...args) { | |
Vue.$ga.event(...args); | |
} | |
/** | |
* Track an FB event with the analytics platform. | |
*/ | |
export function trackFbEvent(type, ...args) { | |
Vue.analytics.fbq.event(type, ...args); | |
} | |
/** | |
* Track a lead by providing just a form name, and an optional category and value. | |
* | |
* @params {String} The name of the form to track | |
* @params {String} The category of the event to track | |
* @params {Number} A value for the event, to calculate RYI | |
*/ | |
export function trackLead(formName, category = '', value = 1) { | |
Vue.analytics.fbq.event('Lead', { | |
content_name: formName, | |
content_category: category, | |
currency: 'GBP', | |
value, | |
}); | |
} | |
/** | |
* Track a lead by providing just a form name, and an optional category and value. | |
* | |
* @params {Number} A value for the event, to calculate RYI | |
* @params {Number} The predicted lifetime value of the customer | |
*/ | |
export function trackSubscribe(value, predictedLtv = null) { | |
Vue.analytics.fbq.event('Subscribe', { | |
currency: 'GBP', | |
value, | |
predicted_ltv: predictedLtv || value, | |
}); | |
} | |
export function trackCompleteRegistration(contentName, status = true, value = 0, currency = 'GBP') { | |
Vue.analytics.fbq.event('CompleteRegistration', { | |
content_name: contentName, | |
status, | |
currency, | |
value, | |
}); | |
} | |
/** | |
* Track a page view by providing just a page name, and an optional category and value. | |
* | |
* @params {String} The name of the form to track | |
* @params {String} The category of the event to track | |
* @params {Number} A value for the event, to calculate RYI | |
*/ | |
export function trackView(pageName, category = '', value = 0) { | |
Vue.analytics.fbq.event('ViewContent', { | |
content_name: pageName, | |
content_category: category, | |
currency: 'GBP', | |
value, | |
}); | |
} | |
/** | |
* Track a successful form submission by providing just a form name, and optionally a value. | |
* | |
* @params {String} The name of the form to track | |
* @params {Number} A value for the event, to calculate RYI | |
*/ | |
export function trackFormSubmit(formName, value = 1) { | |
Vue.$ga.event({ | |
eventCategory: 'Form', | |
eventAction: 'SuccessfulSubmission', | |
eventLabel: formName, | |
eventValue: value, | |
}); | |
} | |
/** | |
* Track a failed form submission by providing just a form name, and optionally a value. | |
* | |
* @params {String} The name of the form to track | |
* @params {Number} A value for the event, to calculate RYI | |
*/ | |
export function trackFormFail(formName, value = 0) { | |
Vue.$ga.event({ | |
eventCategory: 'Form', | |
eventAction: 'FailedSubmission', | |
eventLabel: formName, | |
eventValue: value, | |
}); | |
} | |
/** | |
* Track a video play by providing just an identifier for that video. | |
* | |
* @params {String} An identifier of the video to track | |
* @params {Number} A value for the event, to calculate RYI | |
*/ | |
export function trackVideoPlay(videoLabel, value = 0) { | |
Vue.$ga.event({ | |
eventCategory: 'Video', | |
eventAction: 'Play', | |
eventLabel: videoLabel, | |
eventValue: value, | |
}); | |
} | |
/** | |
* Track a button click by providing just an identifier for that button, and optionally a value. | |
* | |
* @params {String} An identifier of the button to track | |
* @params {Number} A value for the event, to calculate RYI | |
*/ | |
export function trackButtonClick(buttonLabel, value = 0) { | |
Vue.$ga.event({ | |
eventCategory: 'Button', | |
eventAction: 'Click', | |
eventLabel: buttonLabel, | |
eventValue: value, | |
}); | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<template> | |
<div> | |
<slot :trackButtonClick="trackButtonClick" /> | |
</div> | |
</template> | |
<script> | |
import { trackButtonClick } from '~/helpers/analytics'; | |
export default { | |
name: 'AnalyticsTracker', | |
methods: { | |
trackButtonClick, | |
}, | |
}; | |
</script> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<analytics-tracker> | |
<div slot-scope="tracker"> | |
<a | |
href="/trackable" | |
class="c-btn" | |
@click="tracker.trackButtonClick('trackable')" | |
> | |
Click me and I'll be tracked! | |
</a> | |
<button | |
class="c-btn" | |
@click="tracker.trackButtonClick('button-click')" | |
> | |
I'll be tracked too! | |
</button> | |
</div> | |
</analytics-tracker> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment