GTM Capacitor 插件

使用 @capgo/capacitor-gtm

Google Tag Manager 插件的主要界面。

安装

bun add @capgo/capacitor-gtm
bunx cap sync

bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。

导入

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

API 概览

方法	描述
initialize	使用指定的 Container ID 初始化 Google Tag Manager。
push	向 Google Tag Manager 的 dataLayer 推送事件。
setUserProperty	在 Google Tag Manager 的 dataLayer 中设置用户属性。
getValue	从 Google Tag Manager 的 dataLayer 获取值。在 dataLayer 中搜索指定 key 的最新值。
reset	重置 Google Tag Manager 实例并清除所有数据。这将移除 dataLayer 中的所有数据，并需要重新初始化。

示例

initialize()

使用指定的 Container ID 初始化 Google Tag Manager。

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

await GoogleTagManager.initialize({ containerId: 'container-id-123' });

push()

向 Google Tag Manager 的 dataLayer 推送事件。

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

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

setUserProperty()

在 Google Tag Manager 的 dataLayer 中设置用户属性。

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

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

getValue()

从 Google Tag Manager 的 dataLayer 获取值。在 dataLayer 中搜索指定 key 的最新值。

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

const result = await GoogleTagManager.getValue({ key: 'key-123' });
console.log(result);

reset()

重置 Google Tag Manager 实例并清除所有数据。这将移除 dataLayer 中的所有数据，并需要重新初始化。

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

await GoogleTagManager.reset();

完整参考文档

• GitHub 仓库
• 文档
• API 参考文档

从“使用 @capgo/capacitor-gtm”继续

如果你正在使用 使用 @capgo/capacitor-gtm 要规划原生插件工作，请将其与 @capgo/capacitor-gtm 关于 @capgo/capacitor-gtm 中的实现细节， 快速入门 有关“入门指南”中的实现细节， Capgo 插件目录 查看 Capgo 插件目录中的产品工作流， Capgo 提供的 Capacitor 插件 有关 Capgo 开发的 Capacitor 插件的实现细节，以及 添加或更新插件 有关添加或更新插件的实现细节。