plugin-google-gtag.md

sidebar_position	slug
7	/api/plugins/@docusaurus/plugin-google-gtag

📦 plugin-google-gtag

import APITable from '@site/src/components/APITable';

The default Global Site Tag (gtag.js) plugin. It is a JavaScript tagging framework and API that allows you to send event data to Google Analytics, Google Ads, and Google Marketing Platform. This section describes how to configure a Docusaurus site to enable global site tag for Google Analytics.

:::tip

You can use Google's Tag Assistant tool to check if your gtag is set up correctly!

:::

:::caution production only

This plugin is always inactive in development and only active in production to avoid polluting the analytics statistics.

:::

Installation {#installation}

npm install --save @docusaurus/plugin-google-gtag

:::tip

If you use the preset @docusaurus/preset-classic, you don't need to install this plugin as a dependency.

You can configure this plugin through the preset options.

:::

Configuration {#configuration}

Accepted fields:

Name	Type	Default	Description
trackingID	string	Required	The tracking ID of your gtag service.
anonymizeIP	boolean	false	Whether the IP should be anonymized when sending requests.

Example configuration {#ex-config}

You can configure this plugin through preset options or plugin options.

:::tip

Most Docusaurus users configure this plugin through the preset options.

:::

// Preset Options: gtag
// Plugin Options: @docusaurus/plugin-google-gtag

const config = {
  trackingID: 'G-226F0LR9KE',
  anonymizeIP: true,
};