@mobile-reality/gatsby-plugin-gdpr-cookies
Advanced tools
Readme
gatsby-plugin-gdpr-cookies Gatsby pluginyarn add @mobile-reality/gatsby-plugin-gdpr-cookies
or
npm install @mobile-reality/gatsby-plugin-gdpr-cookies
// in your gatsby-config.js
module.exports = {
plugins: [
{
resolve: `gatsby-plugin-gdpr-cookies`,
options: {
googleConsent: {
adStorage: "gatsby-gdpr-google-ad-storage", // default
analyticsStorage: "gatsby-gdpr-google-analytics-storage", // default
functionalityStorage: "gatsby-gdpr-google-functionality-storage", // default
personalizationStorage: "gatsby-gdpr-google-personalization-storage", // default
adUserData: "gatsby-gdpr-google-ad-user-data", // default
adPersonalization: "gatsby-gdpr-google-ad-personalization", // default
waitForUpdate: 500 // default
},
googleAnalytics: {
trackingId: 'YOUR_GOOGLE_ANALYTICS_TRACKING_ID', // leave empty if you want to disable the tracker
anonymize: true, // default
allowAdFeatures: false // default
},
googleTagManager: {
trackingId: 'YOUR_GOOGLE_TAG_MANAGER_TRACKING_ID', // leave empty if you want to disable the tracker
dataLayerName: 'dataLayer', // default
},
googleTag: {
trackingIds: ['YOUR_GOOGLE_TAG_IDS'],
},
facebookPixel: {
pixelId: 'YOUR_FACEBOOK_PIXEL_ID', // leave empty if you want to disable the tracker
cookieName: 'gatsby-gdpr-facebook-pixel', // default
},
tikTokPixel: {
pixelId: 'YOUR_TIKTOK_PIXEL_ID', // leave empty if you want to disable the tracker
cookieName: 'gatsby-gdpr-tiktok-pixel', // default
},
hotjar: {
hjid: 'YOUR_HOTJAR_ID',
hjsv: 'YOUR_HOTJAR_SNIPPET_VERSION',
cookieName: 'gatsby-gdpr-hotjar', // default
},
linkedin: {
trackingId: 'YOUR_LINKEDIN_TRACKING_ID', // leave empty if you want to disable the tracker
cookieName: 'gatsby-gdpr-linkedin', // default
},
hubspot: {
trackingId: 'YOUR_HUBSPOT_TRACKING_ID', // leave empty if you want to disable the tracker
cookieName: 'gatsby-gdpr-hubspot', // default
},
// defines the environments where the tracking should be available - default is ["production"]
environments: ['production', 'development']
},
},
],
}
We're happy to announce that we now support GCMv2. To use any of the Google trackers you need to manage the Google consent cookies (see config example above). If you fail to update the consent cookies the Google trackers will be initialized with the default values thus preventing most of the tracking.
ad_storage: "denied",
analytics_storage: "granted",
functionality_storage: "granted",
personalization_storage: "denied",
ad_user_data: "denied",
ad_personalization: "denied",
security_storage: "granted",
wait_for_update: 500
Google tools will not work properly if the consent cookies are not set correctly. The plugin will not set the cookies for you. You need to manage the cookies in your cookie banner.
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 plugin will check if cookies for Google Analytics or Facebook Pixel have been set between route changes on onRouteUpdate. Reloading the page after setting the cookies is not required anymore.
The page view will be tracked on onRouteUpdate.
This gatsby plugin now supports initializing and tracking right after a user accepts the cookie consent.
// in your cookie banner
import { useLocation } from "@reach/router" // this helps tracking the location
import { initializeAndTrack } from 'gatsby-plugin-gdpr-cookies'
Then you can execute initializeAndTrack(location) in your cookie banner callback. This will initialize the plugin with your options from the gatsby-config.js and then starts tracking the user based on the cookies/services are accepted.
// in your cookie banner
const location = useLocation()
initializeAndTrack(location)
https://github.com/andrezimpel/gatsby-plugin-gdpr-cookies/blob/master/README.md
Andre Zimpel - creator of the original lib https://github.com/andrezimpel/gatsby-plugin-gdpr-cookies
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, hotjar, hubspot in a gdpr form to your site. Consent coming soon.
The npm package @mobile-reality/gatsby-plugin-gdpr-cookies receives a total of 66 weekly downloads. As such, @mobile-reality/gatsby-plugin-gdpr-cookies popularity was classified as not popular.
We found that @mobile-reality/gatsby-plugin-gdpr-cookies demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers 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
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.