Inizia
Copia una richiesta di configurazione con i passaggi di installazione e la guida markdown completa per questo plugin.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-firebase-analytics`
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/firebase-analytics/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.
Installa
Sezione intitolata “Installa”Puoi utilizzare la nostra configurazione assistita dall'IA per installare il plugin. Aggiungi le Capgo competenze al tuo strumento di AI utilizzando il seguente comando:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-pluginsUsa poi il seguente prompt:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-firebase-analytics` plugin in my project.Se preferisci l'installazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche per la piattaforma riportate di seguito:
bun add @capgo/capacitor-firebase-analyticsbunx cap syncImporta
Sezione intitolata “Importa”import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';API Panoramica
Sezione intitolata “API Panoramica”getAppInstanceId
Sezione intitolata “getAppInstanceId”Recupera l'ID dell'istanza dell'applicazione.
Disponibile solo per Android e iOS.
import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';
await FirebaseAnalytics.getAppInstanceId();Recupera l'ID della sessione corrente (ga_session_id).
Disponibile solo per Android e iOS.
import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';
await FirebaseAnalytics.getSessionId();Imposta il livello di consenso dell'utente.
import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';
await FirebaseAnalytics.setConsent({} as SetConsentOptions);Imposta la proprietà dell'ID dell'utente.
import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';
await FirebaseAnalytics.setUserId({} as SetUserIdOptions);setUserProperty
Sezione intitolata “setUserProperty”Imposta una proprietà utente personalizzata a un valore specifico.
import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';
await FirebaseAnalytics.setUserProperty({} as SetUserPropertyOptions);setCurrentScreen
Sezione intitolata “setCurrentScreen”Imposta il nome della schermata corrente.
import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';
await FirebaseAnalytics.setCurrentScreen({} as SetCurrentScreenOptions);logEvent
Sezione intitolata “logEvent”Registra un evento dell'applicazione.
import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';
await FirebaseAnalytics.logEvent({} as LogEventOptions);setSessionTimeoutDuration
Sezione intitolata “setSessionTimeoutDuration”Imposta la durata di inattività che interrompe la sessione corrente.
Solo disponibile per Android e iOS.
import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';
await FirebaseAnalytics.setSessionTimeoutDuration({} as SetSessionTimeoutDurationOptions);setEnabled
Sottosezione intitolata “abilitato”Abilita/disabilita la raccolta automatica dei dati. Il valore non si applica fino alla prossima esecuzione dell'app.
import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';
await FirebaseAnalytics.setEnabled({} as SetEnabledOptions);isEnabled
Sottosezione intitolata “abilitato”Restituisce se la raccolta automatica dei dati è abilitata o meno.
Solo disponibile per Web.
import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';
await FirebaseAnalytics.isEnabled();resetAnalyticsData
Sottosezione intitolata “resetAnalyticsData”Pulisce tutti i dati di analisi per questa app dal dispositivo. Riavvia l'ID dell'applicazione.
Solo disponibile per Android e iOS.
import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';
await FirebaseAnalytics.resetAnalyticsData();initiateOnDeviceConversionMeasurementWithEmailAddress
Sezione intitolata “inizia la misurazione della conversione su dispositivo con indirizzo email”Inizia la misurazione della conversione su dispositivo con indirizzo email.
Disponibile solo per iOS.
import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';
await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithEmailAddress({} as InitiateOnDeviceConversionMeasurementWithEmailAddressOptions);initiateOnDeviceConversionMeasurementWithPhoneNumber
Sezione intitolata “inizia la misurazione della conversione su dispositivo con numero di telefono”Inizia la misurazione della conversione su dispositivo con numero di telefono.
Disponibile solo per iOS.
import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';
await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithPhoneNumber({} as InitiateOnDeviceConversionMeasurementWithPhoneNumberOptions);initiateOnDeviceConversionMeasurementWithHashedEmailAddress
Sezione intitolata “inizia la misurazione della conversione su dispositivo con indirizzo email hashato”Inizia la misurazione della conversione su dispositivo con indirizzo email hashato.
Disponibile solo per iOS.
import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';
await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithHashedEmailAddress({} as InitiateOnDeviceConversionMeasurementWithHashedEmailAddressOptions);initiateOnDeviceConversionMeasurementWithHashedPhoneNumber
Sezione intitolata “inizia la misurazione della conversione sul dispositivo con numero di telefono hashato”Inizia la misurazione della conversione sul dispositivo con un numero di telefono hashato.
Disponibile solo per iOS.
import { FirebaseAnalytics } from '@capgo/capacitor-firebase-analytics';
await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithHashedPhoneNumber({} as InitiateOnDeviceConversionMeasurementWithHashedPhoneNumberOptions);Riferimento di tipo
Sezione intitolata “Riferimento di tipo”GetAppInstanceIdResult
Sezione intitolata “GetAppInstanceIdResult”export interface GetAppInstanceIdResult { /** * The app instance id. * * Not defined if `FirebaseAnalytics.ConsentType.ANALYTICS_STORAGE` has been set to `FirebaseAnalytics.ConsentStatus.DENIED`. * * @since 1.4.0 */ appInstanceId?: string;}GetSessionIdResult
Sezione intitolata “GetSessionIdResult”export interface GetSessionIdResult { /** * The current session id. * * Matches Firebase Analytics `ga_session_id`. * * Not defined if `FirebaseAnalytics.ConsentType.ANALYTICS_STORAGE` has been set to `FirebaseAnalytics.ConsentStatus.DENIED`. * * @since 8.0.1 */ sessionId?: number;}SetConsentOptions
Sezione intitolata “SetConsentOptions”export interface SetConsentOptions { /** * The consent type. * * @since 6.0.0 */ type: ConsentType; /** * The consent status. * * @since 6.0.0 */ status: ConsentStatus;}SetUserIdOptions
Sezione intitolata “SetUserIdOptions”export interface SetUserIdOptions { /** * @since 0.1.0 */ userId: string | null;}SetUserPropertyOptions
Sezione intitolata “SetUserPropertyOptions”export interface SetUserPropertyOptions { /** * @since 0.1.0 */ key: string; /** * @since 0.1.0 */ value: string | null;}SetCurrentScreenOptions
Sezione intitolata “SetCurrentScreenOptions”export interface SetCurrentScreenOptions { /** * @since 0.1.0 */ screenName: string | null; /** * Only available for Android and iOS. * * @default null * @since 0.1.0 */ screenClassOverride?: string | null;}LogEventOptions
Sezione intitolata “LogEventOptions”export interface LogEventOptions { /** * The event name. * * @since 0.1.0 */ name: string; /** * The optional event params. * * @since 0.1.0 */ params?: { [key: string]: any };}SetSessionTimeoutDurationOptions
Sezione intitolata “SetSessionTimeoutDurationOptions”export interface SetSessionTimeoutDurationOptions { /** * Duration in seconds. * * @default 1800 * @since 0.1.0 */ duration: number;}SetEnabledOptions
Sezione intitolata “SetEnabledOptions”export interface SetEnabledOptions { /** * @since 0.1.0 */ enabled: boolean;}IsEnabledResult
Sezione intitolata “IsEnabledResult”export interface IsEnabledResult { /** * @since 0.1.0 */ enabled: boolean;}InitiateOnDeviceConversionMeasurementWithEmailAddressOptions
Sezione intitolata “InitiateOnDeviceConversionMeasurementWithEmailAddressOptions”export interface InitiateOnDeviceConversionMeasurementWithEmailAddressOptions { /** * The email address to initiate on-device conversion measurement with. * * @since 7.2.0 */ emailAddress: string;}InitiateOnDeviceConversionMeasurementWithPhoneNumberOptions
Sezione intitolata “InitiateOnDeviceConversionMeasurementWithPhoneNumberOptions”export interface InitiateOnDeviceConversionMeasurementWithPhoneNumberOptions { /** * The phone number to initiate on-device conversion measurement with. * * @since 7.2.0 */ phoneNumber: string;}Punto di riferimento
Sezione intitolata “Punto di riferimento”Questa pagina è generata dal plugin’s src/definitions.ts. Riavvia la sincronizzazione quando il pubblico API cambia in modo upstream.
Continua da Iniziare
Sezione intitolata “Continua da Iniziare”Se stai utilizzando Iniziare per pianificare il dashboard e le API operazioni, connettilo con API Panoramica per i dettagli di implementazione in API Panoramica, Introduzione per i dettagli di implementazione in Introduzione, API Chiavi per i dettagli di implementazione in API Chiavi, Dispositivi per i dettagli di implementazione in Dispositivi, e Bundle per i dettagli di implementazione nei Pacchetti.