📦 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.

Deprecated

This plugin is deprecated and became useless on July 1, 2023.

Google is moving away from Universal Analytics.

If you are still using this plugin with a UA-* tracking id, you should create a Google Analytics 4 account as soon as possible, and use @docusaurus/plugin-google-gtag instead of this plugin. More details here.

production only

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

Installation

npm

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

Yarn

yarn add @docusaurus/plugin-google-analytics

pnpm

pnpm add @docusaurus/plugin-google-analytics

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

Campos aceitos:

Nome	Type	Padrão	Descrição
trackingID	string	Required	The tracking ID of your analytics service.
anonymizeIP	boolean	false	Whether the IP should be anonymized when sending requests.

Example configuration

Você pode configurar este plugin através das opções de predefinição ou opções do plugin.

tip

A maioria dos usuários do Docusaurus configura este plugin através das configurações de predefinição.

Opções de predefinição

Se você usar uma predefinição, configure este plugin através do opções de predefinição:

docusaurus.config.js

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

Opções do plugin

Se você estiver usando um plugin independente, forneça opções diretamente para o plugin:

docusaurus.config.js

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