feat: add GTM integration

bydawen · bydawen · commit f2ba4cdad008 · 2025-06-06T14:37:19.000+03:00
diff --git a/lms/envs/common.py b/lms/envs/common.py
@@ -1614,6 +1614,13 @@ def _make_mako_template_dirs(settings):
 GOOGLE_ANALYTICS_TRACKING_ID = None
 GOOGLE_ANALYTICS_4_ID = None
 
+################### GOOGLE TAG MANAGER ##################
+# .. setting_name: GOOGLE_TAG_MANAGER_ID
+# .. setting_default: None
+# .. setting_description: The container ID for Google Tag Manager,
+# .. e.g., "GTM-XXXXXX".
+GOOGLE_TAG_MANAGER_ID = None
+
 ######################## BRANCH.IO ###########################
 BRANCH_IO_KEY = ''
 
diff --git a/lms/templates/certificates/accomplishment-base.html b/lms/templates/certificates/accomplishment-base.html
@@ -42,6 +42,15 @@
             gtag('config', '${ga_4_id | n, js_escaped_string}');
         </script>
     % endif
+
+    <% gtm_id = static.get_value("GOOGLE_TAG_MANAGER_ID", getattr(settings, "GOOGLE_TAG_MANAGER_ID", None)) %>
+    % if gtm_id:
+        <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+            new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+          j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+          'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+        })(window,document,'script','dataLayer', '${gtm_id}');</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
@@ -177,6 +177,15 @@
   </script>
 % endif
 
+<% gtm_id = static.get_value("GOOGLE_TAG_MANAGER_ID", getattr(settings, "GOOGLE_TAG_MANAGER_ID", None)) %>
+% if gtm_id:
+    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+        new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+      j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+      'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+    })(window,document,'script','dataLayer', '${gtm_id}');</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
@@ -40,6 +40,14 @@
     </script>
   {% endif %}
 
+  {% if google_tag_manager_id %}
+    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+          new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+        j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+        'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+    })(window,document,'script','dataLayer', '{{ google_tag_manager_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
@@ -74,3 +74,12 @@ def google_analytics_4_id():
     {% google_analytics_4_id %}
     """
     return configuration_helpers.get_value("GOOGLE_ANALYTICS_4_ID", settings.GOOGLE_ANALYTICS_4_ID)
+
+
+@register.simple_tag
+def google_tag_manager_id():
+    """
+    Django template tag that outputs the GOOGLE_TAG_MANAGER_ID:
+    {% google_tag_manager_id %}
+    """
+    return configuration_helpers.get_value("GOOGLE_TAG_MANAGER_ID", settings.GOOGLE_TAG_MANAGER_ID)
