feat: Add GA 4 support to edX platform (#762)

Merge pull request #32032 from raccoongang/sagirov/tCRIL_GA-18 [FC-0014] Add GA 4 support to edX platform Co-authored-by: Brian Mesick <[email protected]>
eduNEXT · Jul 18, 2023 · 5c65a71 · 5c65a71
1 parent eec8871
commit 5c65a71
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 0 deletions.
diff --git a/lms/envs/common.py b/lms/envs/common.py
@@ -1442,6 +1442,7 @@ def _make_mako_template_dirs(settings):
 GOOGLE_SITE_VERIFICATION_ID = ''
 GOOGLE_ANALYTICS_LINKEDIN = 'GOOGLE_ANALYTICS_LINKEDIN_DUMMY'
 GOOGLE_ANALYTICS_TRACKING_ID = None
+GOOGLE_ANALYTICS_4_ID = None
 
 ######################## BRANCH.IO ###########################
 BRANCH_IO_KEY = ''

diff --git a/lms/envs/production.py b/lms/envs/production.py
@@ -687,6 +687,7 @@ def get_env_setting(setting):
 GOOGLE_ANALYTICS_TRACKING_ID = AUTH_TOKENS.get('GOOGLE_ANALYTICS_TRACKING_ID')
 GOOGLE_ANALYTICS_LINKEDIN = AUTH_TOKENS.get('GOOGLE_ANALYTICS_LINKEDIN')
 GOOGLE_SITE_VERIFICATION_ID = ENV_TOKENS.get('GOOGLE_SITE_VERIFICATION_ID')
+GOOGLE_ANALYTICS_4_ID = AUTH_TOKENS.get('GOOGLE_ANALYTICS_4_ID')
 
 ##### BRANCH.IO KEY #####
 BRANCH_IO_KEY = AUTH_TOKENS.get('BRANCH_IO_KEY')

diff --git a/lms/templates/certificates/accomplishment-base.html b/lms/templates/certificates/accomplishment-base.html
@@ -19,6 +19,19 @@
     <title>${document_title}</title>
 
     <%static:css group='style-certificates'/>
+
+
+    <% ga_4_id = static.get_value("GOOGLE_ANALYTICS_4_ID", settings.GOOGLE_ANALYTICS_4_ID) %>
+    % if ga_4_id:
+        <script async src="https://www.googletagmanager.com/gtag/js?id=${ga_4_id}"></script>
+        <script>
+            window.dataLayer = window.dataLayer || [];
+            function gtag(){dataLayer.push(arguments);}
+            gtag('js', new Date());
+
+            gtag('config', '${ga_4_id | n, js_escaped_string}');
+        </script>
+    % endif
 </head>
 
 <body class="layout-accomplishment view-valid-accomplishment ${dir_rtl} certificate certificate-${course_mode_class}" data-view="valid-accomplishment">

diff --git a/lms/templates/main.html b/lms/templates/main.html
@@ -163,6 +163,18 @@
     </script>
 % endif
 
+<% ga_4_id = static.get_value("GOOGLE_ANALYTICS_4_ID", settings.GOOGLE_ANALYTICS_4_ID) %>
+% if ga_4_id:
+  <script async src="https://www.googletagmanager.com/gtag/js?id=${ga_4_id}"></script>
+  <script>
+    window.dataLayer = window.dataLayer || [];
+    function gtag(){dataLayer.push(arguments);}
+    gtag('js', new Date());
+
+    gtag('config', '${ga_4_id | n, js_escaped_string}');
+  </script>
+% endif
+
 <% branch_key = static.get_value("BRANCH_IO_KEY", settings.BRANCH_IO_KEY) %>
 % if branch_key and not is_from_mobile_app:
     <script type="text/javascript">

diff --git a/lms/templates/main_django.html b/lms/templates/main_django.html
@@ -28,6 +28,18 @@
 
   {% optional_include "head-extra.html"|microsite_template_path %}
 
+  {% google_analytics_4_id as ga_4_id %}
+  {% if ga_4_id %}
+    <script async src="https://www.googletagmanager.com/gtag/js?id={{ ga_4_id }}"></script>
+    <script>
+      window.dataLayer = window.dataLayer || [];
+      function gtag(){dataLayer.push(arguments);}
+      gtag('js', new Date());
+
+      gtag('config', '{{ ga_4_id }}');
+    </script>
+  {% endif %}
+
   <meta name="path_prefix" content="{{EDX_ROOT_URL}}">
 </head>
 

diff --git a/openedx/core/djangoapps/site_configuration/templatetags/configuration.py b/openedx/core/djangoapps/site_configuration/templatetags/configuration.py
@@ -65,3 +65,12 @@ def microsite_template_path(template_name):
     """
     template_name = theming_helpers.get_template_path(template_name)
     return template_name[1:] if template_name[0] == '/' else template_name
+
+
+@register.simple_tag
+def google_analytics_4_id():
+    """
+    Django template tag that outputs the GOOGLE_ANALYTICS_4_ID:
+    {% google_analytics_4_id %}
+    """
+    return configuration_helpers.get_value("GOOGLE_ANALYTICS_4_ID", settings.GOOGLE_ANALYTICS_4_ID)