ガイド
Capacitor で Firebase Analytics を使う方法
@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 |
自動データ収集の有効/無効を切り替えます。この設定はアプリの次回の起動時から適用されます。 |
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 プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor プラグインの実装詳細については、 プラグインの追加または更新 プラグインの追加または更新に関する実装詳細については、 Ionic Enterprise プラグインの代替案 Ionic Enterprise Plugin Alternatives のプロダクトワークフロー、および Capgo Native Build Capgo Native Builds のプロダクトワークフローについては、