指南
如何在 Capacitor 中使用 Firebase 分析
使用@capgo/capacitor-firebase-analytics
Capacitor插件用于Firebase Analytics。
安装
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 |
开启/关闭自动数据收集。该值不会立即生效，直到下一次应用启动。 |
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 仓库.
完整参考
从使用@capgo/capacitor-firebase-analytics继续
如果您正在使用 使用@capgo/capacitor-firebase-analytics 为了规划原生插件工作，连接它与 Capgo插件目录 关于Capgo插件目录中的产品工作流程 Capacitor由Capgo提供的插件 关于Capacitor由Capgo提供的插件的实现细节 添加或更新插件 关于添加或更新插件的实现细节 Ionic企业插件替代品 为 Ionic Enterprise Plugin Alternatives 产品工作流程, 和 Capgo 本地构建 为 Capgo 本地构建 产品工作流程, 和