📦 plugin-google-gtag

默认的 全局网站代码 (gtag.js) 插件。它是一个 JavaScript 标签框架和 API，允许您将事件数据发送到 Google Analytics（分析）、Google Ads 和 Google Marketing Platform。本节介绍如何配置 Docusaurus 站点以启用 Google Analytics（分析）的全局网站代码。

提示

您可以使用 Google 的 Tag Assistant 工具来检查您的 gtag 是否设置正确！

仅限生产环境

此插件在开发环境中始终处于非活动状态，并且仅在生产环境中激活，以避免污染分析统计数据。

安装

npm

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

Yarn

yarn add @docusaurus/plugin-google-gtag

pnpm

pnpm add @docusaurus/plugin-google-gtag

Bun

bun add @docusaurus/plugin-google-gtag

提示

如果您使用预设 @docusaurus/preset-classic，则无需将此插件作为依赖项安装。

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

配置

接受的字段

名称	类型	默认值	描述
trackingID	string | string[]	必需	您的 gtag 服务的跟踪 ID。可以提供多个 ID。
anonymizeIP	boolean	false	发送请求时是否匿名化 IP。

示例配置

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

提示

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

预设选项

如果您使用预设，请通过 预设选项配置此插件

docusaurus.config.js

module.exports = {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        gtag: {
          trackingID: 'G-999X9XX9XX',
          anonymizeIP: true,
        },
      },
    ],
  ],
};

插件选项

如果您使用的是独立插件，请直接向插件提供选项

docusaurus.config.js

module.exports = {
  plugins: [
    [
      '@docusaurus/plugin-google-gtag',
      {
        trackingID: 'G-999X9XX9XX',
        anonymizeIP: true,
      },
    ],
  ],
};