GTM

Using @capgo/capacitor-gtm

The main interface for the Google Tag Manager plugin.

Install

bun add @capgo/capacitor-gtm
bunx cap sync

What This Plugin Exposes

• initialize - Initializes Google Tag Manager with the specified container ID.
• push - Pushes an event to the Google Tag Manager dataLayer.
• setUserProperty - Sets a user property in the Google Tag Manager dataLayer.
• getValue - Gets a value from the Google Tag Manager dataLayer. Searches through the dataLayer for the most recent value of the specified key.

Example Usage

initialize

Initializes Google Tag Manager with the specified container ID.

import { GoogleTagManager } from '@capgo/capacitor-gtm';

await GoogleTagManager.initialize({} as { containerId: string; timeout?: number });

push

Pushes an event to the Google Tag Manager dataLayer.

import { GoogleTagManager } from '@capgo/capacitor-gtm';

await GoogleTagManager.push({
  event: 'purchase',
  parameters: {
    value: 99.99,
    currency: 'USD'
  }
});

setUserProperty

Sets a user property in the Google Tag Manager dataLayer.

import { GoogleTagManager } from '@capgo/capacitor-gtm';

await GoogleTagManager.setUserProperty({
  key: 'user_type',
  value: 'premium'
});

getValue

Gets a value from the Google Tag Manager dataLayer. Searches through the dataLayer for the most recent value of the specified key.

import { GoogleTagManager } from '@capgo/capacitor-gtm';

await GoogleTagManager.getValue({} as { key: string });

Full Reference

• GitHub: https://github.com/Cap-go/capacitor-gtm/
• Docs: /docs/plugins/gtm/

Keep going from Using @capgo/capacitor-gtm

If you are using Using @capgo/capacitor-gtm to plan native plugin work, connect it with @capgo/capacitor-gtm for the implementation detail in @capgo/capacitor-gtm, Getting Started for the implementation detail in Getting Started, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, and Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins.