docusaurus/website/versioned_docs/version-2.0.0-beta.10/api/plugins/plugin-google-analytics.md

sidebar_position	id	title	slug
6	plugin-google-analytics	📦 plugin-google-analytics	/api/plugins/@docusaurus/plugin-google-analytics

The default Google Analytics plugin. It is a JavaScript library for measuring how users interact with your website in the production build. If you are using Google Analytics 4 you might need to consider using plugin-google-gtag instead.

Installation

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

:::tip

If you have installed @docusaurus/preset-classic, you don't need to install it as a dependency.

:::

Configuration

Accepted fields:

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

Example configuration

Here's an example configuration object.

You can provide it as preset options or plugin options.

:::tip

Most Docusaurus users configure this plugin through the preset options.

:::

const config = {
  trackingID: 'UA-141789564-1',
  anonymizeIP: true,
};

Preset options

If you use a preset, configure this plugin through the preset options:

module.exports = {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        // highlight-start
        googleAnalytics: {
          trackingID: 'UA-141789564-1',
          anonymizeIP: true,
        },
        // highlight-end
      },
    ],
  ],
};

Plugin options

If you are using a standalone plugin, provide options directly to the plugin:

module.exports = {
  plugins: [
    [
      '@docusaurus/plugin-google-analytics',
      // highlight-start
      {
        trackingID: 'UA-141789564-1',
        anonymizeIP: true,
      },
      // highlight-end
    ],
  ],
};