feat: add GTM integration #36859

bydawen · 2025-06-05T10:21:25Z

Open edX forum post with a proposal of the feature:
https://discuss.openedx.org/t/add-gtm-support-to-open-edx-core/16234

Added GTM support to enable easier integration of analytics and tracking scripts. Making it more flexible for platform operators to manage tags via the site configuration panel in the admin section of the platform:

If Google Tag Manager ID configured correctly it will appear on the website with corresponding GTM scripts initialisations:

Also we made PR to enable similar support on the MFE parts of edX platform:
frontend-platform

openedx-webhooks · 2025-06-05T10:21:30Z

Thanks for the pull request, @bydawen!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

kdmccormick

I know this still a draft, just some early feedback. Before submitting for review, make sure to link this to supporting documentation such as a product proposal, relevant github issues, linked PRs, etc.

lms/envs/common.py

kdmccormick · 2025-06-05T14:35:47Z

lms/envs/production.py

+##### GOOGLE TAG MANAGER IDS #####
+GOOGLE_TAG_MANAGER_ID = AUTH_TOKENS.get('GOOGLE_TAG_MANAGER_ID')
+


Suggested change

##### GOOGLE TAG MANAGER IDS #####

GOOGLE_TAG_MANAGER_ID = AUTH_TOKENS.get('GOOGLE_TAG_MANAGER_ID')

Either the default value will come in from common.py, or a custom value will be set in the LMS_CFG YAML file. This line would have no effect and should be removed.

Yeah, you totally correct, this is completely unnecessary now. Thank you for advice!

bydawen · 2025-06-06T11:46:37Z

I know this still a draft, just some early feedback. Before submitting for review, make sure to link this to supporting documentation such as a product proposal, relevant github issues, linked PRs, etc.

Hi @kdmccormick, thank you for the review and remarks.

For this PR, I forgot to mark it as a draft before submitting — my apologies for that.

My colleague created a forum post about GTM integration to gather feedback and start a discussion. I've also pinned the link at the top of the PR description:
https://discuss.openedx.org/t/add-gtm-support-to-open-edx-core/16234

igobranco · 2025-06-09T14:11:36Z

IMO you should also add GTM environment configuration.

Example:

https://github.com/fccn/nau-themes/blob/daa7b28139fde9a3c68a555a52a3fa601741f1cb/edx-platform/nau-basic/lms/templates/head-extra.html#L28

What I want to highlight is the possibility to have custom GTM environments. This is important when you have to manage a complex configuration on GTM. Like test it before on DEV/STAGE environments before publishing to production. Just view our implementation and be inspired by it!

Copy from my comment on Open edX Forum: https://discuss.openedx.org/t/add-gtm-support-to-open-edx-core/16234/5

kdmccormick

A couple requests. I'm also checking with my team on whether this needs a Product Proposal or whether the forum post is sufficient.

kdmccormick · 2025-06-10T15:50:34Z

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)) %>


Suggested change

<% gtm_id = static.get_value("GOOGLE_TAG_MANAGER_ID", getattr(settings, "GOOGLE_TAG_MANAGER_ID", None)) %>

<% gtm_id = static.get_value("GOOGLE_TAG_MANAGER_ID", settings.GOOGLE_TAG_MANAGER_ID) %>

There is no reason to use getattr when we are certain that settings.GOOGLE_TAG_MANAGER_ID will at least be defined with a default value of None. In fact, it is harmful to use getattr, because it would silence errors in the case where "GOOGLE_TAG_MANAGER_ID" is typo'd, renamed, or removed.

This applies in general when writing Python -- always prefer accessing the attribute directly, only use getattr when absolutely necessary.

Thank you, fixed

kdmccormick · 2025-06-10T15:51:11Z

lms/envs/common.py

+################### GOOGLE TAG MANAGER ##################
+# .. setting_name: GOOGLE_TAG_MANAGER_ID
+# .. setting_default: None
+# .. setting_description: The container ID for Google Tag Manager,


Please explain more. Why would I set this? What does it do?

Made a more detailed description of these settings.
Thank you for review!

feanil · 2025-06-10T17:46:49Z

Is it possible to use the site theming capability to insert this instead? See the comment on your discourse post: https://discuss.openedx.org/t/add-gtm-support-to-open-edx-core/16234/5?u=feanil

kdmccormick

See @feanil ' s comment. I can see the community need for an easy way to configure GTM, but this is part of a general problem (adding configurable JS snippets) and we'd rather not continue adding vendor-specific settings into edx-platform unless absolutely necessary.

bydawen · 2025-06-11T10:18:21Z

Is it possible to use the site theming capability to insert this instead? See the comment on your discourse post: https://discuss.openedx.org/t/add-gtm-support-to-open-edx-core/16234/5?u=feanil

Hi @feanil, I’ve replied on the forum post about this. In short, the main reason behind our approach is to keep the implementation minimal.

kdmccormick · 2025-06-11T14:40:42Z

keep the implementation minimal.

The minimal implementation is the one which does not add any new code :) Using site theming does not add any new code that needs to be maintained, but adding a new one-off setting and vendor-specific JS does.

bydawen requested review from feanil and kdmccormick as code owners June 5, 2025 10:21

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jun 5, 2025

openedx-webhooks added this to Contributions Jun 5, 2025

github-project-automation bot moved this to Needs Triage in Contributions Jun 5, 2025

bydawen marked this pull request as draft June 5, 2025 10:21

kdmccormick reviewed Jun 5, 2025

View reviewed changes

lms/envs/common.py Show resolved Hide resolved

kdmccormick reviewed Jun 5, 2025

View reviewed changes

bydawen mentioned this pull request Jun 6, 2025

feat: add GTM integration openedx/frontend-platform#814

Open

bydawen force-pushed the rg/gtm-support branch 2 times, most recently from 01bc5df to f2ba4cd Compare June 6, 2025 11:37

bydawen marked this pull request as ready for review June 6, 2025 11:50

kdmccormick requested changes Jun 10, 2025

View reviewed changes

feat: add GTM integration

6ca46ad

bydawen force-pushed the rg/gtm-support branch from f2ba4cd to 6ca46ad Compare June 11, 2025 10:03

mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Jun 12, 2025

PKulkoRaccoonGang assigned bydawen Jul 7, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add GTM integration #36859

feat: add GTM integration #36859

bydawen commented Jun 5, 2025 •

edited

Loading

Uh oh!

openedx-webhooks commented Jun 5, 2025 •

edited

Loading

Uh oh!

kdmccormick left a comment

Uh oh!

Uh oh!

kdmccormick Jun 5, 2025

Uh oh!

bydawen Jun 6, 2025

Uh oh!

bydawen commented Jun 6, 2025

Uh oh!

igobranco commented Jun 9, 2025

Uh oh!

kdmccormick left a comment

Uh oh!

kdmccormick Jun 10, 2025 •

edited

Loading

Uh oh!

bydawen Jun 11, 2025

Uh oh!

kdmccormick Jun 10, 2025

Uh oh!

bydawen Jun 11, 2025

Uh oh!

feanil commented Jun 10, 2025

Uh oh!

kdmccormick left a comment

Uh oh!

bydawen commented Jun 11, 2025

Uh oh!

kdmccormick commented Jun 11, 2025

Uh oh!

Uh oh!

		##### GOOGLE TAG MANAGER IDS #####
		GOOGLE_TAG_MANAGER_ID = AUTH_TOKENS.get('GOOGLE_TAG_MANAGER_ID')

	<% gtm_id = static.get_value("GOOGLE_TAG_MANAGER_ID", getattr(settings, "GOOGLE_TAG_MANAGER_ID", None)) %>
	<% gtm_id = static.get_value("GOOGLE_TAG_MANAGER_ID", settings.GOOGLE_TAG_MANAGER_ID) %>

feat: add GTM integration #36859

Are you sure you want to change the base?

feat: add GTM integration #36859

Conversation

bydawen commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openedx-webhooks commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kdmccormick left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kdmccormick Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

bydawen Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

bydawen commented Jun 6, 2025

Uh oh!

igobranco commented Jun 9, 2025

Uh oh!

kdmccormick left a comment

Choose a reason for hiding this comment

Uh oh!

kdmccormick Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bydawen Jun 11, 2025

Choose a reason for hiding this comment

Uh oh!

kdmccormick Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

bydawen Jun 11, 2025

Choose a reason for hiding this comment

Uh oh!

feanil commented Jun 10, 2025

Uh oh!

kdmccormick left a comment

Choose a reason for hiding this comment

Uh oh!

bydawen commented Jun 11, 2025

Uh oh!

kdmccormick commented Jun 11, 2025

Uh oh!

Uh oh!

bydawen commented Jun 5, 2025 •

edited

Loading

openedx-webhooks commented Jun 5, 2025 •

edited

Loading

kdmccormick Jun 10, 2025 •

edited

Loading