Use Google Consent Manager for Analytics

Author: iMattPro

styles/all/template/event/overall_header_stylesheets_after.html

@@ -1,12 +1,47 @@
 {% if GOOGLEANALYTICS_ID %}
+	{% if S_CONSENTMANAGER_ANALYTICS_ENABLED %}
+	<script>
+		window.dataLayer = window.dataLayer || [];
+		window.gtag = window.gtag || function(){window.dataLayer.push(arguments);}
+
+		window.gtag('consent', 'default', {
+			'analytics_storage': 'denied'
+		});
+
+		(function(window) {
+			function updateConsent() {
+				window.gtag('consent', 'update', {
+					'analytics_storage': window.consentManager && typeof window.consentManager.hasConsent === 'function' && window.consentManager.hasConsent('analytics') ? 'granted' : 'denied'
+				});
+			}
+
+			if (window.consentManager && typeof window.consentManager.onChange === 'function')
+			{
+				window.consentManager.onChange(updateConsent);
+			}
+			else
+			{
+				updateConsent();
+			}
+		})(window);
+	</script>
+	{% endif %}
 	<!-- Google tag (gtag.js) - Google Analytics -->
-	<script{% if S_CONSENTMANAGER_ANALYTICS_ENABLED %} type="text/plain" data-consent-category="analytics"{% endif %} async src="https://www.googletagmanager.com/gtag/js?id={{ GOOGLEANALYTICS_ID }}"></script>
-	<script{% if S_CONSENTMANAGER_ANALYTICS_ENABLED %} type="text/plain" data-consent-category="analytics"{% endif %}>
+	<script async src="https://www.googletagmanager.com/gtag/js?id={{ GOOGLEANALYTICS_ID }}"></script>
+	<script>
 		window.dataLayer = window.dataLayer || [];
-		function gtag(){dataLayer.push(arguments);}
-		gtag('js', new Date());
+		window.gtag = window.gtag || function(){window.dataLayer.push(arguments);}
+		{% if S_CONSENTMANAGER_ANALYTICS_ENABLED %}
+		if (window.consentManager && typeof window.consentManager.hasConsent === 'function')
+		{
+			window.gtag('consent', 'update', {
+				'analytics_storage': window.consentManager.hasConsent('analytics') ? 'granted' : 'denied'
+			});
+		}
+		{% endif %}
+		window.gtag('js', new Date());
 
-		gtag('config', '{{ GOOGLEANALYTICS_ID }}', {
+		window.gtag('config', '{{ GOOGLEANALYTICS_ID }}', {
 			{%- EVENT phpbb_googleanalytics_gtag_options -%}
 			{%- if S_REGISTERED_USER %}'user_id': '{{ GOOGLEANALYTICS_USER_ID }}',{% endif -%}
 			{%- if S_ANONYMIZE_IP %}'anonymize_ip': true,{% endif -%}

tests/functional/google_analytics_consentmanager_test.php

@@ -30,7 +30,7 @@ protected static function setup_extensions()
 		return $extensions;
 	}
 
-	public function test_consentmanager_defers_google_analytics_scripts()
+	public function test_consentmanager_enables_google_consent_mode()
 	{
 		if (!self::is_consentmanager_available())
 		{
@@ -53,12 +53,17 @@ public function test_consentmanager_defers_google_analytics_scripts()
 
 		self::assertSame(
 			'https://www.googletagmanager.com/gtag/js?id=' . $this->sample_ga_code,
-			$crawler->filter('head > script[type="text/plain"][data-consent-category="analytics"][src*="googletagmanager.com/gtag/js"]')->attr('src')
-		);
-		self::assertGreaterThan(
-			0,
-			$crawler->filter('head > script[type="text/plain"][data-consent-category="analytics"]')->count()
+			$crawler->filter('head > script[src*="googletagmanager.com/gtag/js"]')->attr('src')
 		);
+
+		$head = $crawler->filter('head')->html();
+		self::assertStringContainsString("window.gtag('consent', 'default'", $head);
+		self::assertStringContainsString("'analytics_storage': 'denied'", $head);
+		self::assertStringContainsString("window.consentManager.onChange(updateConsent)", $head);
+		self::assertStringContainsString("window.consentManager.hasConsent('analytics') ? 'granted' : 'denied'", $head);
+		self::assertStringNotContainsString("'ad_storage'", $head);
+		self::assertStringNotContainsString("'ad_user_data'", $head);
+		self::assertStringNotContainsString("'ad_personalization'", $head);
 	}
 
 	public function test_google_analytics_runs_normally_when_analytics_category_is_disabled()
@@ -94,10 +99,7 @@ public function test_google_analytics_runs_normally_when_analytics_category_is_d
 			'https://www.googletagmanager.com/gtag/js?id=' . $this->sample_ga_code,
 			$crawler->filter('head > script[src*="googletagmanager.com/gtag/js"]')->attr('src')
 		);
-		self::assertSame(
-			0,
-			$crawler->filter('head > script[type="text/plain"][data-consent-category="analytics"]')->count()
-		);
+		self::assertStringNotContainsString("window.gtag('consent', 'default'", $crawler->filter('head')->html());
 	}
 
 	protected static function is_consentmanager_available()