gatsby-plugin-gdpr-cookies
Advanced tools
Gatsby plugin to add google analytics and facebook pixel in a gdpr form to your site
Gatsby plugin to add google analytics and facebook pixel in a GDPR form to your site.
npm install --save gatsby-plugin-gdpr-cookies
// in your gatsby-config.js
module.exports = {
plugins: [
{
resolve: `gatsby-plugin-gdpr-cookies`,
options: {
googleAnalytics: {
trackingId: 'YOUR_GOOGLE_ANALYTICS_TRACKING_ID', // leave empty if you want to disable the tracker
cookieName: 'gatsby-gdpr-google-analytics', // default
anonymize: true // default
},
googleTagManager: {
trackingId: 'YOUR_GOOGLE_TAG_MANAGER_TRACKING_ID', // leave empty if you want to disable the tracker
cookieName: 'gatsby-gdpr-google-tagmanager', // default
dataLayerName: 'dataLayer', // default
},
facebookPixel: {
pixelId: 'YOUR_FACEBOOK_PIXEL_ID', // leave empty if you want to disable the tracker
cookieName: 'gatsby-gdpr-facebook-pixel', // default
},
// defines the environments where the tracking should be available - default is ["production"]
environments: ['production', 'development']
},
},
],
}
First of all the plugin checks in which environment your site is running. If it's currently running in one of your defined environments it will add the tracking code by default to the <head>/<body> of your site. It will not be activated or initialized by this.
By default this plugin will not send any data to Google or Facebook to make it GDPR compliant. The user first needs to accept your cookie policy. By accepting that you need to set cookies for the tracker you want to use - gatsby-gdpr-google-analytics, gatsby-gdpr-google-tagmanager, gatsby-gdpr-facebook-pixel. Depending on the user input the value of each of the cookies should be true or false.
If the gatsby-gdpr-google-analytics cookie is set to true, Google Analytics will be initialized onClientEntry. Same is for the Google Tag Manager and Facebook Pixel.
The page view will then be tracked on onRouteUpdate.
Important: read below about using the plugin with Google Tag Manager.
trackingIdHere you place your Google Analytics tracking ID.
cookieNameYou can use a custom cookie name if you need to!
anonymizeSome countries (such as Germany) require you to use the _anonymizeIP function for Google Analytics. Otherwise you are not allowed to use it. The option adds two blocks to the code:
ga('set', 'anonymizeIp', 1);
If your visitors should be able to set an Opt-Out-Cookie (No future tracking) you can set a link e.g. in your imprint as follows:
import ReactGA from 'react-ga';
render() {
return (
<div>
<ReactGA.OutboundLink
eventLabel="myLabel"
to="http://www.example.com"
target="_blank"
trackerNames={['tracker2']}
>
My Link
</ReactGA.OutboundLink>
</div>
);
}
trackingIdHere you place your Google Tag Manager tracking ID.
cookieNameYou can use a custom cookie name if you need to!
dataLayerNameData layer name
gtmAuthGoogle Tag Manager environment auth string
gtmPreviewGoogle Tag Manager environment preview name
defaultDataLayerData layer to be set before GTM is loaded. Should be an object or a function that is executed in the browser, e.g.:
defaultDataLayer: { platform: "gatsby" }
defaultDataLayer: function() {
return {
pageType: window.pageType,
}
}
Out of the box this plugin will simply load Google Tag Manager on the initial page/app load. It’s up to you to fire tags based on changes in your app.
This plugin will fire a new event called gatsbyRouteChange on Gatsby's onRouteUpdate (only if the consent was given by a visitor). To record this in Google Tag Manager, we will need to add a trigger to the desired tag to listen for the event:
In order to do that, go to Tags. Under Triggering click the pencil icon, then the ”+” button to add a new trigger. In the Choose a trigger window, click on the ”+” button again. Choose the trigger type by clicking the pencil button and clicking Custom event. For event name, enter gatsbyRouteChange. This tag will now catch every route change in Gatsby, and you can add Google tag services as you wish to it.
pixelIdHere you place your Facebook Pixel ID.
cookieNameYou can use a custom cookie name if you need to!
Thanks goes to these wonderful people who helped shaping this project.
FAQs
Gatsby plugin to add google analytics, google tag manager facebook pixel, tik tok pixel and hotjar in a gdpr form to your site. Consent coming soon.
We found that gatsby-plugin-gdpr-cookies demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware negotiators share how modern cybercriminals operate like corporations, using specialized teams, negotiation tactics, and reputation management.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.