Update Google Analytics example for App Router (#66021)
<!-- Thanks for opening a PR! Your contribution is much appreciated. To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below. Choose the right checklist for the change(s) that you're making: ## For Contributors ### Improving Documentation - Run `pnpm prettier-fix` to fix formatting issues before opening the PR. - Read the Docs Contribution Guide to ensure your contribution follows the docs guidelines: https://nextjs.org/docs/community/contribution-guide ### Adding or Updating Examples - The "examples guidelines" are followed from our contributing doc https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md - Make sure the linting passes by running `pnpm build && pnpm lint`. See https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md ### Fixing a bug - Related issues linked using `fixes #number` - Tests added. See: https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ### Adding a feature - Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. (A discussion must be opened, see https://github.com/vercel/next.js/discussions/new?category=ideas) - Related issues/discussions are linked using `fixes #number` - e2e tests added (https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) - Documentation added - Telemetry added. In case of a feature if it's used or not. - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ## For Maintainers - Minimal description (aim for explaining to someone not on the team to understand the PR) - When linking to a Slack thread, you might want to share details of the conclusion - Link both the Linear (Fixes NEXT-xxx) and the GitHub issues - Add review comments if necessary to explain to the reviewer the logic behind a change ### What? ### Why? ### How? Closes NEXT- Fixes # --> Hello This PR updates the `with-google-analytics` example to use: - App Router - TypeScript - @next/third-parties Co-authored-by: Sam Ko <sam@vercel.com>
This commit is contained in:
qqww08
GitHub
parent
5cba51e342
commit
16c4e47c14
13 changed files with 92 additions and 114 deletions
|
|
@ -1,6 +1,8 @@
|
|||
# Example app with analytics
|
||||
|
||||
This example shows how to use [Next.js](https://github.com/vercel/next.js) along with [Google Analytics](https://developers.google.com/analytics/devguides/collection/gtagjs/). A custom [\_app](https://nextjs.org/docs/advanced-features/custom-app) is used to inject [tracking snippet](https://developers.google.com/analytics/devguides/collection/gtagjs/) and track [pageviews](https://developers.google.com/analytics/devguides/collection/gtagjs/pages) and [event](https://developers.google.com/analytics/devguides/collection/gtagjs/events).
|
||||
This example shows how to use [Next.js](https://github.com/vercel/next.js) along with [Google Analytics 4](https://developers.google.com/analytics/devguides/collection/ga4).
|
||||
|
||||
If you are using the Pages Router, please refer to the [pages/ documentation.](https://nextjs.org/docs/pages/building-your-application/optimizing/third-party-libraries)
|
||||
|
||||
## Deploy your own
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
import Page from "../components/Page";
|
||||
import Page from "../../components/Page";
|
||||
|
||||
export default function About() {
|
||||
return (
|
||||
27
examples/with-google-analytics/app/contact/page.tsx
Normal file
27
examples/with-google-analytics/app/contact/page.tsx
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
"use client";
|
||||
import { useRef, type FormEvent } from "react";
|
||||
import Page from "../../components/Page";
|
||||
import { sendGTMEvent } from "@next/third-parties/google";
|
||||
|
||||
export default function About() {
|
||||
const inputRef = useRef<HTMLTextAreaElement | null>(null);
|
||||
|
||||
const handleSubmit = (e: FormEvent) => {
|
||||
e.preventDefault();
|
||||
sendGTMEvent({ event: "message submit", value: inputRef.current?.value });
|
||||
inputRef.current!.value = "";
|
||||
};
|
||||
|
||||
return (
|
||||
<Page>
|
||||
<h1>This is the Contact page</h1>
|
||||
<form onSubmit={handleSubmit}>
|
||||
<label>
|
||||
<span>Message:</span>
|
||||
<textarea ref={inputRef} />
|
||||
</label>
|
||||
<button type="submit">submit</button>
|
||||
</form>
|
||||
</Page>
|
||||
);
|
||||
}
|
||||
20
examples/with-google-analytics/app/layout.tsx
Normal file
20
examples/with-google-analytics/app/layout.tsx
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
import { GoogleTagManager } from "@next/third-parties/google";
|
||||
|
||||
export const metadata = {
|
||||
title: "Google Analytics Next.js",
|
||||
description:
|
||||
"This example shows how to use Next.js along with Google Analytics.",
|
||||
};
|
||||
|
||||
export default function RootLayout({
|
||||
children,
|
||||
}: {
|
||||
children: React.ReactNode;
|
||||
}) {
|
||||
return (
|
||||
<html lang="en">
|
||||
<GoogleTagManager gtmId={process.env.NEXT_PUBLIC_GA_ID as string} />
|
||||
<body>{children}</body>
|
||||
</html>
|
||||
);
|
||||
}
|
||||
|
|
@ -1,10 +0,0 @@
|
|||
import Header from "./Header";
|
||||
|
||||
export default function Page({ children }) {
|
||||
return (
|
||||
<div>
|
||||
<Header />
|
||||
{children}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
11
examples/with-google-analytics/components/Page.tsx
Normal file
11
examples/with-google-analytics/components/Page.tsx
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
import Header from "./Header";
|
||||
import type { PropsWithChildren } from "react";
|
||||
|
||||
export default function Page({ children }: PropsWithChildren<{}>) {
|
||||
return (
|
||||
<div>
|
||||
<Header />
|
||||
{children}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
export const GA_TRACKING_ID = process.env.NEXT_PUBLIC_GA_ID;
|
||||
|
||||
// https://developers.google.com/analytics/devguides/collection/gtagjs/pages
|
||||
export const pageview = (url) => {
|
||||
window.gtag("config", GA_TRACKING_ID, {
|
||||
page_path: url,
|
||||
});
|
||||
};
|
||||
|
||||
// https://developers.google.com/analytics/devguides/collection/gtagjs/events
|
||||
export const event = ({ action, category, label, value }) => {
|
||||
window.gtag("event", action, {
|
||||
event_category: category,
|
||||
event_label: label,
|
||||
value: value,
|
||||
});
|
||||
};
|
||||
|
|
@ -6,8 +6,14 @@
|
|||
"start": "next start"
|
||||
},
|
||||
"dependencies": {
|
||||
"@next/third-parties": "^14.2.3",
|
||||
"next": "latest",
|
||||
"react": "^18.2.0",
|
||||
"react-dom": "^18.2.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "20.12.12",
|
||||
"@types/react": "^18.3.2",
|
||||
"typescript": "^5.4.5"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,46 +0,0 @@
|
|||
import Head from "next/head";
|
||||
import { useRouter } from "next/router";
|
||||
import Script from "next/script";
|
||||
import { useEffect } from "react";
|
||||
import * as gtag from "../lib/gtag";
|
||||
|
||||
const App = ({ Component, pageProps }) => {
|
||||
const router = useRouter();
|
||||
useEffect(() => {
|
||||
const handleRouteChange = (url) => {
|
||||
gtag.pageview(url);
|
||||
};
|
||||
router.events.on("routeChangeComplete", handleRouteChange);
|
||||
return () => {
|
||||
router.events.off("routeChangeComplete", handleRouteChange);
|
||||
};
|
||||
}, [router.events]);
|
||||
|
||||
return (
|
||||
<>
|
||||
<Head>
|
||||
<script
|
||||
dangerouslySetInnerHTML={{
|
||||
__html: `
|
||||
window.dataLayer = window.dataLayer || [];
|
||||
function gtag(){dataLayer.push(arguments);}
|
||||
gtag('js', new Date());
|
||||
|
||||
gtag('config', '${gtag.GA_TRACKING_ID}', {
|
||||
page_path: window.location.pathname,
|
||||
});
|
||||
`,
|
||||
}}
|
||||
/>
|
||||
</Head>
|
||||
{/* Global Site Tag (gtag.js) - Google Analytics */}
|
||||
<Script
|
||||
strategy="afterInteractive"
|
||||
src={`https://www.googletagmanager.com/gtag/js?id=${gtag.GA_TRACKING_ID}`}
|
||||
/>
|
||||
<Component {...pageProps} />
|
||||
</>
|
||||
);
|
||||
};
|
||||
|
||||
export default App;
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
import { Component } from "react";
|
||||
import Page from "../components/Page";
|
||||
|
||||
import * as gtag from "../lib/gtag";
|
||||
|
||||
export default class Contact extends Component {
|
||||
state = { message: "" };
|
||||
|
||||
handleInput = (e) => {
|
||||
this.setState({ message: e.target.value });
|
||||
};
|
||||
|
||||
handleSubmit = (e) => {
|
||||
e.preventDefault();
|
||||
|
||||
gtag.event({
|
||||
action: "submit_form",
|
||||
category: "Contact",
|
||||
label: this.state.message,
|
||||
});
|
||||
|
||||
this.setState({ message: "" });
|
||||
};
|
||||
|
||||
render() {
|
||||
return (
|
||||
<Page>
|
||||
<h1>This is the Contact page</h1>
|
||||
<form onSubmit={this.handleSubmit}>
|
||||
<label>
|
||||
<span>Message:</span>
|
||||
<textarea onChange={this.handleInput} value={this.state.message} />
|
||||
</label>
|
||||
<button type="submit">submit</button>
|
||||
</form>
|
||||
</Page>
|
||||
);
|
||||
}
|
||||
}
|
||||
24
examples/with-google-analytics/tsconfig.json
Normal file
24
examples/with-google-analytics/tsconfig.json
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2017",
|
||||
"lib": ["dom", "dom.iterable", "esnext"],
|
||||
"allowJs": true,
|
||||
"skipLibCheck": true,
|
||||
"strict": false,
|
||||
"noEmit": true,
|
||||
"incremental": true,
|
||||
"module": "esnext",
|
||||
"esModuleInterop": true,
|
||||
"moduleResolution": "node",
|
||||
"resolveJsonModule": true,
|
||||
"isolatedModules": true,
|
||||
"jsx": "preserve",
|
||||
"plugins": [
|
||||
{
|
||||
"name": "next"
|
||||
}
|
||||
]
|
||||
},
|
||||
"include": ["next-env.d.ts", ".next/types/**/*.ts", "**/*.ts", "**/*.tsx"],
|
||||
"exclude": ["node_modules"]
|
||||
}
|
||||
Loading…
Reference in a new issue