Inizia con Getting Started

Installa

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

Importa

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

API Panoramica

getAppInstanceId

Recupera l'ID dell'istanza dell'app.

Disponibile solo per Android e iOS.

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

await FirebaseAnalytics.getAppInstanceId();

getSessionId

Recupera l'ID di sessione corrente (ga_session_id).

Disponibile solo per Android e iOS.

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

await FirebaseAnalytics.getSessionId();

setConsent

Imposta il modo di consenso dell'utente.

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

await FirebaseAnalytics.setConsent({} as SetConsentOptions);

setUserId

Imposta la proprietà ID utente.

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

await FirebaseAnalytics.setUserId({} as SetUserIdOptions);

setUserProperty

Imposta una proprietà utente personalizzata a un valore specifico.

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

await FirebaseAnalytics.setUserProperty({} as SetUserPropertyOptions);

setCurrentScreen

Imposta il nome della schermata corrente.

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

await FirebaseAnalytics.setCurrentScreen({} as SetCurrentScreenOptions);

logEvent

Registra un evento dell'applicazione.

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

await FirebaseAnalytics.logEvent({} as LogEventOptions);

setSessionTimeoutDuration

Imposta la durata di inattività che termina la sessione corrente.

Disponibile solo per Android e iOS.

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

await FirebaseAnalytics.setSessionTimeoutDuration({} as SetSessionTimeoutDurationOptions);

setEnabled

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

Restituisce se la raccolta automatica dei dati è abilitata o meno.

Disponibile solo per Web.

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

await FirebaseAnalytics.isEnabled();

resetAnalyticsData

Cancella tutti i dati di analisi per questa app dal dispositivo. Riavvia l'ID dell'istanza dell'app.

Disponibile solo per Android e iOS.

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

await FirebaseAnalytics.resetAnalyticsData();

initiateOnDeviceConversionMeasurementWithEmailAddress

Avvia la misurazione della conversione sul dispositivo con un indirizzo email.

Sono disponibile solo per iOS.

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

await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithEmailAddress({} as InitiateOnDeviceConversionMeasurementWithEmailAddressOptions);

initiateOnDeviceConversionMeasurementWithPhoneNumber

Inizia la misurazione di conversione su dispositivo con un numero di telefono.

Sono disponibile solo per iOS.

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

await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithPhoneNumber({} as InitiateOnDeviceConversionMeasurementWithPhoneNumberOptions);

initiateOnDeviceConversionMeasurementWithHashedEmailAddress

Inizia la misurazione di conversione su dispositivo con un indirizzo email hashato.

Sono disponibile solo per iOS.

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

await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithHashedEmailAddress({} as InitiateOnDeviceConversionMeasurementWithHashedEmailAddressOptions);

initiateOnDeviceConversionMeasurementWithHashedPhoneNumber

Inizia la misurazione di conversione su 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

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

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

export interface SetConsentOptions {
  /**
   * The consent type.
   *
   * @since 6.0.0
   */
  type: ConsentType;
  /**
   * The consent status.
   *
   * @since 6.0.0
   */
  status: ConsentStatus;
}

SetUserIdOptions

export interface SetUserIdOptions {
  /**
   * @since 0.1.0
   */
  userId: string | null;
}

SetUserPropertyOptions

export interface SetUserPropertyOptions {
  /**
   * @since 0.1.0
   */
  key: string;
  /**
   * @since 0.1.0
   */
  value: string | null;
}

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

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

export interface SetSessionTimeoutDurationOptions {
  /**
   * Duration in seconds.
   *
   * @default 1800
   * @since 0.1.0
   */
  duration: number;
}

SetEnabledOptions

export interface SetEnabledOptions {
  /**
   * @since 0.1.0
   */
  enabled: boolean;
}

IsEnabledResult

export interface IsEnabledResult {
  /**
   * @since 0.1.0
   */
  enabled: boolean;
}

InitiateOnDeviceConversionMeasurementWithEmailAddressOptions

export interface InitiateOnDeviceConversionMeasurementWithEmailAddressOptions {
  /**
   * The email address to initiate on-device conversion measurement with.
   *
   * @since 7.2.0
   */
  emailAddress: string;
}

InitiateOnDeviceConversionMeasurementWithPhoneNumberOptions

export interface InitiateOnDeviceConversionMeasurementWithPhoneNumberOptions {
  /**
   * The phone number to initiate on-device conversion measurement with.
   *
   * @since 7.2.0
   */
  phoneNumber: string;
}

Fonte di verità

Questa pagina è generata dal plugin src/definitions.tsRiepiloga la sincronizzazione quando il pubblico API cambia in modo upstream.

Continua da Inizia

Se stai utilizzando Inizia per pianificare la 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 Pacchetti per i dettagli di implementazione in Pacchetti.