Firebase Analytics Capacitor 插件

使用 @capgo/capacitor-firebase-analytics

用于 Firebase Analytics 的 Capacitor 插件

安装

bun add @capgo/capacitor-firebase-analytics
bunx cap sync

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

导入

import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';

API 概览

方法	描述
getAppInstanceId	获取应用实例 ID。
getSessionId	获取当前会话 ID（ga_session_id).
setConsent	设置用户的同意模式。
setUserId	设置用户 ID 属性。
setUserProperty	设置自定义用户属性及其对应值。
setCurrentScreen	设置当前页面名称。
logEvent	记录应用事件。
setSessionTimeoutDuration	设置因用户闲置而导致当前会话结束的持续时间。
setEnabled	启用/禁用自动数据收集。该设置在下次启动 App 时生效。
isEnabled	返回是否已启用自动数据收集。
resetAnalyticsData	清除设备上此应用的所有分析数据，并重置应用实例 ID。
logTransaction	记录一条 StoreKit 2 交易。
initiateOnDeviceConversionMeasurementWithEmailAddress	使用电子邮件地址启动设备端转化衡量。
initiateOnDeviceConversionMeasurementWithPhoneNumber	使用电话号码启动设备端转化衡量。
initiateOnDeviceConversionMeasurementWithHashedEmailAddress	使用经过哈希处理的电子邮件地址启动设备端转化衡量。
initiateOnDeviceConversionMeasurementWithHashedPhoneNumber	使用经过哈希处理的电话号码启动设备端转化衡量。

示例

getAppInstanceId()

获取应用实例 ID。

import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';

const result = await FirebaseAnalytics.getAppInstanceId();
console.log(result);

getSessionId()

获取当前会话 ID（ga_session_id).

import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';

const result = await FirebaseAnalytics.getSessionId();
console.log(result);

setConsent()

设置用户的同意模式。

import { FirebaseAnalytics, ConsentStatus, ConsentType } from '@capgo/capacitor-firebase-analytics';

await FirebaseAnalytics.setConsent({
  type: ConsentType.AdPersonalization,
  status: ConsentStatus.Granted,
});

setUserId()

设置用户 ID 属性。

import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';

await FirebaseAnalytics.setUserId({ userId: 'user-id-123' });

setUserProperty()

设置自定义用户属性及其对应的值。

import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';

await FirebaseAnalytics.setUserProperty({
  key: 'key-123',
  value: 'value',
});

setCurrentScreen()

设置当前页面名称。

import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';

await FirebaseAnalytics.setCurrentScreen({ screenName: 'screen' });

上表列出了 16 个核心方法。有关监听器、版本辅助函数以及每个方法的完整契约，请参阅 GitHub 仓库.

完整参考文档

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

继续使用 @capgo/capacitor-firebase-analytics

如果你正在使用 使用 @capgo/capacitor-firebase-analytics 要规划原生插件工作，请将其与 Capgo 插件目录 查看 Capgo 插件目录中的产品工作流， Capgo 提供的 Capacitor 插件 查看由 Capgo 提供的 Capacitor 插件中的实现细节， 添加或更新插件 查看添加或更新插件中的实现细节， Ionic Enterprise 插件替代方案 查看 Ionic Enterprise 插件替代方案中的产品工作流，以及 Capgo Native Build 查看 Capgo Native Builds 中的产品工作流。