# 📦 plugin-google-tag-manager

A plugin for adding [Google Tag Manager (gtm.js)](https://developers.google.com/tag-platform/tag-manager) to a Docusaurus site. Use this plugin in conjunction with the standard [gtag plugin](/guides/api-plugins-plugin-google-gtag) for in-depth analysis of how users are using your site.

:::callout{intent="tip"}
You can use [Google's Tag Assistant](https://tagassistant.google.com/) tool to check if tag manager is set up correctly!
:::

:::callout{intent="warning" title="production only"}
This plugin is always inactive in development and **only active in production** to avoid polluting the analytics statistics.
:::

## Installation

```bash npm2yarn
npm install --save @docusaurus/plugin-google-tag-manager
```

:::callout{intent="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](/guides/using-plugins#docusauruspreset-classic).
:::

## Configuration

Accepted fields:

```mdx-code-block
<APITable>
```

| Name          | Type     | Default      | Description                                                 |
| ------------- | -------- | ------------ | ----------------------------------------------------------- |
| `containerId` | `string` | **Required** | Your Tag Manager container Id (usually starts with `GTM-`). |

```mdx-code-block
</APITable>
```

### Example configuration

You can configure this plugin through preset options or plugin options.

:::callout{intent="tip"}
Most Docusaurus users configure this plugin through the preset options.
:::

```js config-tabs
// Preset Options: googleTagManager
// Plugin Options: @docusaurus/plugin-google-tag-manager

const config = {
  containerId: 'GTM-12345',
};
```

## Related pages

- [Docusaurus plugins](./api-plugins-overview.md)
- [📦 plugin-content-docs](./api-plugins-plugin-content-docs.md)
- [📦 plugin-content-blog](./api-plugins-plugin-content-blog.md)
- [📦 plugin-content-pages](./api-plugins-plugin-content-pages.md)
- [📦 plugin-client-redirects](./api-plugins-plugin-client-redirects.md)
- [📦 plugin-debug](./api-plugins-plugin-debug.md)
- [📦 plugin-google-gtag](./api-plugins-plugin-google-gtag.md)
- [📦 plugin-rsdoctor](./api-plugins-plugin-rsdoctor.md)
- [📦 plugin-svgr](./api-plugins-plugin-svgr.md)
- [📦 plugin-ideal-image](./api-plugins-plugin-ideal-image.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.