Getting Started

Copiez une invite de configuration avec les étapes d'installation et le guide Markdown complet pour ce plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-gtm`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/gtm/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Installation

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de la commande suivante :

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Ensuite, utilisez la prompt suivante :

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-gtm` plugin in my project.

Si vous préférez une configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

bun add @capgo/capacitor-gtm
bunx cap sync

Importer

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

API Vue d'ensemble

`initialize`

Initialise Google Tag Manager avec l'ID de conteneur spécifié.

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

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

`push`

Envoie un événement à la couche de données Google Tag Manager.

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

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

`setUserProperty`

Fixe une propriété utilisateur dans la couche de données Google Tag Manager.

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

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

`getValue`

Récupère une valeur à partir de la couche de données Google Tag Manager. Recherche dans la couche de données pour la valeur la plus récente du clé spécifiée.

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

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

`reset`

Réinitialise l'instance Google Tag Manager et efface toutes les données. Cela supprimera toutes les données de la couche de données et nécessitera une réinitialisation.

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

await GoogleTagManager.reset();

Source Of Truth

Cette page est générée à partir du plugin’s src/definitions.tsRe-générez la synchronisation lorsque les modifications publiques API se produisent en amont.

Continuez de Getting Started

Si vous utilisez Getting Started pour planifier le tableau de bord et les opérations API, connectez-l’avec Utilisez @capgo/capacitor-gtm pour la capacité native dans Utilisez @capgo/capacitor-gtm, API Overview pour les détails d'implémentation dans API Présentation Introduction pour les détails d'implémentation dans Introduction API Clés pour les détails d'implémentation dans API Clés, et Appareils pour les détails d'implémentation dans Appareils.