Skip to main content
Capgo logo
Back to plugins
@capgo/capacitor-gtm
Tutorial
by github.com/Cap-go

GTM

Google Tag Manager integration for analytics and tracking

Downloads/week

2.0k

GitHub Stars

7

Guide

Tutorial on 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