428af8af5e
Co-authored-by: Goolsby, Lane <lanegoolsby@rocketmortgage.com> Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com> fix https://github.com/facebook/docusaurus/issues/7221
2.2 KiB
| sidebar_position | slug |
|---|---|
| 6 | /api/plugins/@docusaurus/plugin-google-analytics |
📦 plugin-google-analytics
import APITable from '@site/src/components/APITable';
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.
:::danger Deprecated
This plugin is deprecated, and will become 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.
:::
:::caution production only
This plugin is always inactive in development and only active in production to avoid polluting the analytics statistics.
:::
Installation
npm install --save @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
Accepted fields:
<APITable>
| 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. |
</APITable>
Example configuration
You can configure this plugin through preset options or plugin options.
:::tip
Most Docusaurus users configure this plugin through the preset options.
:::
// Preset Options: googleAnalytics
// Plugin Options: @docusaurus/plugin-google-analytics
const config = {
trackingID: 'UA-141789564-1',
anonymizeIP: true,
};