📦 plugin-google-gtag

The default Global Site Tag (gtag.js) plugin. 它是一个 JavaScript 标签框架和 API，允许你将事件数据发送到 Google Analytics, Google Ads 和 Google Marketing Platform。 本章节会介绍如何配置 Docusaurus 站点以为 Google Analytics 启用全局网站标签。

提示

你可以用 Google's Tag Assistant 来检查你的 gtag 是否设置正常！

production only

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

安装流程

npm

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

Yarn

yarn add @docusaurus/plugin-google-gtag

pnpm

pnpm add @docusaurus/plugin-google-gtag

提示

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

You can configure this plugin through the preset options.

配置

接受的字段：

参数	类型	默认值	描述
trackingID	string | string[]	必填	你的 gtag 服务的 tracking ID。 It is possible to provide multiple ids.
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,
      },
    ],
  ],
};