开始使用

复制一个包含安装步骤和本插件完整 Markdown 指南的配置提示。

        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.

安装

bun add @capgo/capacitor-gtm
bunx cap sync

导入

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

API概述

`initialize`

初始化 Google Tag Manager，指定容器 ID。

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

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

`push`

将事件推送到 Google Tag Manager 数据层。

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

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

`setUserProperty`

在 Google Tag Manager 数据层中设置用户属性。

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

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

`getValue`

从 Google Tag Manager 数据层中获取值。在数据层中搜索指定键的最新值。

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

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

`reset`

重置 Google Tag Manager 实例并清除所有数据。此操作将从数据层中删除所有数据并要求重新初始化。

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

await GoogleTagManager.reset();

真实数据来源

本页面是从插件生成的 src/definitions.ts当公共API上游发生变化时，请重新运行同步