Skip to content

feat(analytics): add extra params prop to gtm #1426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(analytics): add extra params prop to gtm #1426

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 49 additions & 3 deletions website/components/Analytics.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ export const getGTMIdFromSrc = (src: string | undefined) => {
interface TagManagerProps {
trackingId: string;
src?: string;
extraParams?: ExtraParams[];
}

export function GoogleTagManager(props: TagManagerProps) {
const _isOnPremises = !!props.src;
const hasTrackingId = "trackingId" in props;
Expand All @@ -29,6 +31,19 @@ export function GoogleTagManager(props: TagManagerProps) {
`/ns.html?id=${hasTrackingId ? props.trackingId : ""}`,
hostname,
);
const reservedKeys = new Set(["id", "ns"]);

for (const { key, value } of (props.extraParams ?? [])) {
if (reservedKeys.has(key.toLowerCase())) {
continue;
}

if (key) {
src.searchParams.append(key, value);
noscript.searchParams.append(key, value);
}
}

return (
<>
<Head>
Expand Down Expand Up @@ -103,6 +118,19 @@ const snippet = () => {
});
});
};

/** @title {{key}} - {{value}} */
interface ExtraParams {
/**
* @description key for extra param.
*/
key: string;
/**
* @description value for extra param.
*/
value: string;
}

export interface Props {
/**
* @description google tag manager container id. For more info: https://developers.google.com/tag-platform/tag-manager/web#standard_web_page_installation .
Expand All @@ -118,13 +146,23 @@ export interface Props {
* @description custom url for serving google tag manager.
*/
src?: string;
/**
* @description extra params for google tag manager url.
*/
extraParams?: ExtraParams[];
/**
* @description Disable forwarding events into dataLayer
*/
disableAutomaticEventPush?: boolean;
}
export default function Analytics(
{ trackingIds, src, googleAnalyticsIds, disableAutomaticEventPush }: Props,
{
trackingIds,
src,
googleAnalyticsIds,
disableAutomaticEventPush,
extraParams,
}: Props,
) {
const isDeploy = !!context.isDeploy;
// Prevent breacking change. Drop this in next major to only have
Expand All @@ -137,14 +175,22 @@ export default function Analytics(
{isDeploy && (
<>
{trackingIds?.map((trackingId) => (
<GoogleTagManager src={src} trackingId={trackingId.trim()} />
<GoogleTagManager
src={src}
trackingId={trackingId.trim()}
extraParams={extraParams}
/>
))}
{googleAnalyticsIds?.map((trackingId) => (
<GTAG trackingId={trackingId.trim()} />
))}
{/* Drop this in next major to only have trackingId or trackingId and src */}
{src && !trackingIds?.length && (
<GoogleTagManager src={src} trackingId={trackingId} />
<GoogleTagManager
src={src}
trackingId={trackingId}
extraParams={extraParams}
/>
)}
</>
)}
Expand Down
Loading