feat(GA,GTM): configurable dataLayer name #163

huang-julien · 2024-07-18T23:09:45Z

🔗 Linked issue

#154

❓ Type of change

📖 Documentation (updates to the documentation or readme)
🐞 Bug fix (a non-breaking change that fixes an issue)
👌 Enhancement (improving an existing functionality)
✨ New feature (a non-breaking change that adds functionality)
🧹 Chore (updates to the build process or auxiliary tools and libraries)
⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

Update to tpc 1.1.1 with minor changes.

adds a new dataLayerName option
on our side we handle theses options and we define defaults for dataLayerName to avoid conflicts between gtm and ga
- defaultGa for google analytics
- defaultGtm for google tag manager

vercel · 2024-07-18T23:09:49Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
scripts-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 19, 2024 8:55pm
scripts-playground	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 19, 2024 8:55pm

docs/content/scripts/analytics/google-analytics.md

src/runtime/registry/google-tag-manager.ts

flashdesignory

LGTM, assuming the imports are good as is 👍

harlan-zw · 2024-07-20T00:58:35Z

scripts/generateTpcScripts.ts

@@ -13,32 +12,27 @@ export interface TpcDescriptor {
  tpcTypeImport: string
  key: string
  registry?: any
-  options: ({


any particular reason to change this? this matches the useRegistryScript interface so keeps code closer aligned

harlan-zw · 2024-07-20T01:01:20Z

src/runtime/registry/google-tag-manager.ts


 declare global {
  interface Window extends GoogleTagManagerApi {}
 }
 export type GoogleTagManagerInput = RegistryScriptInput<typeof GoogleTagManagerOptions>

 export function useScriptGoogleTagManager<T extends GoogleTagManagerApi>(_options?: GoogleTagManagerInput) {
+  _options = defu(_options, { dataLayerName: 'defaultGtm' })
  return useRegistryScript<T, typeof GoogleTagManagerOptions>(_options?.key || 'google-tag-manager', options => ({
    scriptInput: {
      src: withQuery('https://www.googletagmanager.com/gtm.js', { id: options?.id }),


the src needs to include the dataLayer name otherwise how will it link it 🤔

hmmm it's not in TPC 👀 . Is there a default name for data layers ?
cc @flashdesignory

Oh wait I just merged this and I forgot I left this comment.

Can we do some testing on it and make sure it's actually working? I'm pretty sure it will just use dataLayer if not configured.

cc: @flashdesignory

harlan-zw · 2024-07-20T01:04:06Z

Personally, I'd prefer to see the default behaviour to use window.dataLayer, I think it's more intuitive for end users if they really need to pull for the underlying implementation.

Is using dataLayers an existing best practice otherwise? A non-nested key would also simplify things, just using directly what the user provides. Again this is more intuitive for end users, we want to avoid hiding implementation details.

flashdesignory · 2024-07-21T02:45:56Z

Personally, I'd prefer to see the default behaviour to use window.dataLayer, I think it's more intuitive for end users if they really need to pull for the underlying implementation.

Is using dataLayers an existing best practice otherwise? A non-nested key would also simplify things, just using directly what the user provides. Again this is more intuitive for end users, we want to avoid hiding implementation details.

The idea of the window.dataLayers object was to keep it scoped, but it is less popular, compared to just assigning custom names directly to the windows object.

we can revert back to the previous implementation, where we'd use window.dataLayer, unless we get another dataLayer name passed in. TPC, will expect a value from the wrapper (even if it's the default name).

harlan-zw · 2024-07-21T03:50:15Z

Oh my mistake, I didn't realize this is how it was baked into TPC. We can go with this solution to move this along.

Some doc for end-users on which window var is set may be useful.

huang-julien added 5 commits July 18, 2024 22:55

feat(tpc): update tpc to 1.1.1

7710a0c

docs and add default

be03db4

mark optionnals

20f974d

refactor: use void 0 instead of undefined

e0417d7

fix: import path

b886a94

huang-julien requested review from flashdesignory, kara, harlan-zw and housseindjirdeh July 18, 2024 23:09

huang-julien marked this pull request as draft July 18, 2024 23:10

harlan-zw reviewed Jul 19, 2024

View reviewed changes

docs/content/scripts/analytics/google-analytics.md Outdated Show resolved Hide resolved

harlan-zw reviewed Jul 19, 2024

View reviewed changes

docs/content/scripts/analytics/google-analytics.md Outdated Show resolved Hide resolved

harlan-zw reviewed Jul 19, 2024

View reviewed changes

docs/content/scripts/analytics/google-analytics.md Outdated Show resolved Hide resolved

flashdesignory reviewed Jul 19, 2024

View reviewed changes

src/runtime/registry/google-tag-manager.ts Outdated Show resolved Hide resolved

flashdesignory approved these changes Jul 19, 2024

View reviewed changes

fix: path and lint

4cf66a6

vercel bot deployed to Preview – scripts-playground July 19, 2024 15:41 View deployment

change docs

05edc72

vercel bot deployed to Preview – scripts-playground July 19, 2024 15:46 View deployment

vercel bot deployed to Preview – scripts-docs July 19, 2024 15:49 View deployment

refactor: use string for function return generation

5d76acc

vercel bot deployed to Preview – scripts-playground July 19, 2024 18:26 View deployment

vercel bot deployed to Preview – scripts-docs July 19, 2024 18:29 View deployment

huang-julien marked this pull request as ready for review July 19, 2024 20:47

huang-julien added 2 commits July 19, 2024 22:48

doc: remove uneeded var

7908695

doc: remove uneeded property

c40b336

vercel bot deployed to Preview – scripts-playground July 19, 2024 20:52 View deployment

vercel bot deployed to Preview – scripts-docs July 19, 2024 20:55 View deployment

harlan-zw reviewed Jul 20, 2024

View reviewed changes

harlan-zw changed the title ~~feat(tpc): update to 1.1.1~~ feat(GA,GTM): configurable dataLayer name Jul 21, 2024

harlan-zw merged commit 95bac7c into main Jul 21, 2024
4 checks passed

harlan-zw deleted the feat/up_tpc branch July 21, 2024 03:52

harlan-zw mentioned this pull request Jul 21, 2024

Two or more GTM containers #154

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(GA,GTM): configurable dataLayer name #163

feat(GA,GTM): configurable dataLayer name #163

huang-julien commented Jul 18, 2024 •

edited by harlan-zw

Loading

vercel bot commented Jul 18, 2024 •

edited

Loading

flashdesignory left a comment

harlan-zw Jul 20, 2024 •

edited

Loading

harlan-zw Jul 20, 2024

huang-julien Jul 20, 2024

harlan-zw Jul 21, 2024

harlan-zw commented Jul 20, 2024 •

edited

Loading

flashdesignory commented Jul 21, 2024

harlan-zw commented Jul 21, 2024 •

edited

Loading

feat(GA,GTM): configurable dataLayer name #163

feat(GA,GTM): configurable dataLayer name #163

Conversation

huang-julien commented Jul 18, 2024 • edited by harlan-zw Loading

🔗 Linked issue

❓ Type of change

📚 Description

vercel bot commented Jul 18, 2024 • edited Loading

flashdesignory left a comment

Choose a reason for hiding this comment

harlan-zw Jul 20, 2024 • edited Loading

Choose a reason for hiding this comment

harlan-zw Jul 20, 2024

Choose a reason for hiding this comment

huang-julien Jul 20, 2024

Choose a reason for hiding this comment

harlan-zw Jul 21, 2024

Choose a reason for hiding this comment

harlan-zw commented Jul 20, 2024 • edited Loading

flashdesignory commented Jul 21, 2024

harlan-zw commented Jul 21, 2024 • edited Loading

huang-julien commented Jul 18, 2024 •

edited by harlan-zw

Loading

vercel bot commented Jul 18, 2024 •

edited

Loading

harlan-zw Jul 20, 2024 •

edited

Loading

harlan-zw commented Jul 20, 2024 •

edited

Loading

harlan-zw commented Jul 21, 2024 •

edited

Loading