📦 plugin-google-analytics

默认的 Google Analytics 插件。 Google Analytics 是一个在生产环境用于监测用户和你的网站的交互情况的 JavaScript 库。 如果您正在使用 Google Analytics 4，您可能需要考虑换用 plugin-google-gtag 。

已弃用

此插件已被废弃并且于2023年7月1日失效。

Google 正在迁移到 Universal Analytics 。

如果您仍在使用此插件与 UA-* 跟踪id， 您应该尽快创建一个 Google Analytics 4 账户并使用 @docusaurus/plugin-google-gtag 而不是此插件。 更多详情请参阅这里。

仅可用于生产环境

这个插件始终不会工作在开发过程中，只在生产环境中启用，防止污染分析数据。

安装流程

npm

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

Yarn

yarn add @docusaurus/plugin-google-analytics

pnpm

pnpm add @docusaurus/plugin-google-analytics

Bun

bun add @docusaurus/plugin-google-analytics

提示

如果你已经安装了 @docusaurus/preset-classic，就不需要安装这个包了。

您可以通过预设选项配置此插件。

配置

接受的字段：

参数	类型	默认值	描述
trackingID	string	必填	你的分析服务的 tracking ID。
anonymizeIP	boolean	false	发送请求时是否使用匿名 IP。

示例配置

你可以通过预设选项或插件选项来配置这个插件。

提示

大多数 Docusaurus 用户通过预设选项配置此插件。

预设选项

如果你使用预设，你可以通过预设选项配置这个插件：

docusaurus.config.js

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

插件选项

如果你用的是独立插件，直接向插件提供选项：

docusaurus.config.js

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