analytics package

Le SDK Web Firebase Analytics. Ce SDK ne fonctionne pas dans un environnement Node.js.

Les fonctions

Fonction Description
fonction(application, ...)
getAnalytics (application) Renvoie une instance Analytics pour l'application donnée.
initializeAnalytics (application, options) Renvoie une instance Analytics pour l'application donnée.
fonction (analyseInstance, ...)
getGoogleAnalyticsClientId(analyticsInstance) Récupère un identifiant Google Analytics unique pour le client Web. Voir client_id .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. Voir les vues d'écran de suivi .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. Voir Mesurer les exceptions .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .
logEvent (analyticsInstance, eventName, eventParams, options) Envoie un événement Google Analytics avec eventParams donné. Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil. Voir Pages vues .
setAnalyticsCollectionEnabled (analyticsInstance, activé) Définit si la collecte Google Analytics est activée pour cette application sur cet appareil. Définit window['ga-disable-analyticsId'] = true;
setCurrentScreen (analyticsInstance, screenName, options) Utilisez la commande gtag config pour définir screen_name .
setUserId (analyticsInstance, identifiant, options) Utilisez la commande gtag config pour définir user_id .
setUserProperties (analyticsInstance, propriétés, options) Utilisez la commande gtag config pour définir tous les paramètres spécifiés.
fonction()
est pris en charge() Il s'agit d'une méthode statique publique fournie aux utilisateurs qui encapsule quatre vérifications différentes : 1. Vérifiez s'il ne s'agit pas d'un environnement d'extension de navigateur. 2. Vérifiez si les cookies sont activés dans le navigateur actuel. 3. Vérifiez si IndexedDB est pris en charge par l'environnement du navigateur. 4. Vérifiez si le contexte actuel du navigateur est valide pour utiliser IndexedDB.open() .
fonction (consentSettings, ...)
setConsent(consentSettings) Définit l'état de consentement de l'utilisateur final applicable pour cette application Web sur toutes les références gtag une fois Firebase Analytics initialisé. Utilisez ConsentSettings pour spécifier des valeurs de type de consentement individuelles. Par défaut, les types de consentement sont définis sur « accordé ».
fonction(customParams, ...)
setDefaultEventParameters(customParams) Ajoute des données qui seront définies sur chaque événement enregistré à partir du SDK, y compris les événements automatiques. Avec la commande "set" de gtag, les valeurs transmises persistent sur la page actuelle et sont transmises avec tous les événements ultérieurs.
fonction(options, ...)
paramètres (options) Configure Firebase Analytics pour utiliser des noms gtag ou dataLayer personnalisés. Destiné à être utilisé si le script gtag.js a été installé sur cette page indépendamment de Firebase Analytics et utilise des noms autres que ceux par défaut pour la fonction gtag ou pour dataLayer . Doit être appelé avant d'appeler getAnalytics() sinon cela n'aura aucun effet.

Interfaces

Interface Description
Analytique Une instance de Firebase Analytics.
Options d'appel d'analyse Options supplémentaires pouvant être transmises aux appels de méthode Analytics telles que logEvent , etc.
Paramètres d'analyse Options d'initialisation de l'instance Analytics .
Paramètres de consentement Paramètres de statut de consentement pour chaque type de consentement. Pour plus d'informations, consultez la documentation de référence GA4 pour connaître l'état et les types de consentement. .
Paramètres de contrôle Paramètres de contrôle gtag.js standard. Pour plus d'informations, consultez la documentation de référence GA4. .
Paramètres personnalisés Tous les paramètres personnalisés que l'utilisateur peut transmettre à gtag .
Paramètres d'événement Paramètres d'événement gtag.js standard. Pour plus d'informations, consultez la documentation de référence GA4. .
GtagConfigParams Un ensemble de paramètres de configuration Google Analytics courants reconnus par gtag.js .
Article Type Item Google Analytics standard.
Promotion Champ précédemment utilisé par certains événements Google Analytics.
ParamètresOptions Spécifie les options personnalisées pour votre instance Firebase Analytics. Vous devez les définir avant d'initialiser firebase.analytics() .

Tapez les alias

Tapez l'alias Description
ConsentStatusString Si un type de consentement particulier a été accordé ou refusé.
Devise Type de devise standard de Google Analytics.
Nom de l'événement personnalisé Toute chaîne de nom d'événement personnalisé ne figurant pas dans la liste standard des noms d'événements recommandés.
ChaîneNomÉvénement Saisissez les noms d'événements Google Analytics standard. logEvent accepte également n'importe quelle chaîne personnalisée et l'interprète comme un nom d'événement personnalisé.

fonction(application, ...)

getAnalytics (application)

Renvoie une instance Analytics pour l'application donnée.

Signature:

export declare function getAnalytics(app?: FirebaseApp): Analytics;

Paramètres

Paramètre Taper Description
application FirebaseApp La FirebaseApp à utiliser.

Retour:

Analytique

initializeAnalytics (application, options)

Renvoie une instance Analytics pour l'application donnée.

Signature:

export declare function initializeAnalytics(app: FirebaseApp, options?: AnalyticsSettings): Analytics;

Paramètres

Paramètre Taper Description
application FirebaseApp La FirebaseApp à utiliser.
choix Paramètres d'analyse

Retour:

Analytique

fonction (analyseInstance, ...)

getGoogleAnalyticsClientId(analyticsInstance)

Récupère un identifiant Google Analytics unique pour le client Web. Voir client_id .

Signature:

export declare function getGoogleAnalyticsClientId(analyticsInstance: Analytics): Promise<string>;

Paramètres

Paramètre Taper Description
analyseInstance Analytique

Retour:

Promesse<string>

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .

Signature:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'add_payment_info', eventParams?: {
    coupon?: EventParams['coupon'];
    currency?: EventParams['currency'];
    items?: EventParams['items'];
    payment_type?: EventParams['payment_type'];
    value?: EventParams['value'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement 'add_payment_info'
eventParams { coupon ? : EventParams ['coupon']; devise ? : EventParams ['devise']; éléments ? : EventParams ['articles']; type_de_paiement ? : EventParams ['type de paiement']; valeur ? : EventParams ['valeur']; [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .

Signature:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'purchase' | 'refund', eventParams?: {
    value?: EventParams['value'];
    currency?: EventParams['currency'];
    transaction_id: EventParams['transaction_id'];
    tax?: EventParams['tax'];
    shipping?: EventParams['shipping'];
    items?: EventParams['items'];
    coupon?: EventParams['coupon'];
    affiliation?: EventParams['affiliation'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement 'achat' | 'remboursement'
eventParams {valeur ? : EventParams ['valeur']; devise ? : EventParams ['devise']; transaction_id : EventParams ['identifiant de transaction']; taxe ? : EventParams ['impôt']; expédition ? : EventParams ['expédition']; éléments ? : EventParams ['articles']; coupon ? : EventParams ['coupon']; affiliation ? : EventParams ['affiliation']; [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

Voir les vues d'écran de suivi .

Signature:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'screen_view', eventParams?: {
    firebase_screen: EventParams['firebase_screen'];
    firebase_screen_class: EventParams['firebase_screen_class'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement 'écran_view'
eventParams { firebase_screen : EventParams ['firebase_screen']; firebase_screen_class : EventParams ['firebase_screen_class']; [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .

Signature:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'search' | 'view_search_results', eventParams?: {
    search_term?: EventParams['search_term'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement 'recherche' | 'view_search_results'
eventParams { search_term ? : EventParams ['terme de recherche']; [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .

Signature:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'select_content', eventParams?: {
    content_type?: EventParams['content_type'];
    item_id?: EventParams['item_id'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement 'select_content'
eventParams { content_type ? : EventParams ['content_type']; item_id? : EventParams ['ID de l'article']; [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .

Signature:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'select_item', eventParams?: {
    items?: EventParams['items'];
    item_list_name?: EventParams['item_list_name'];
    item_list_id?: EventParams['item_list_id'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement 'sélectionner un article'
eventParams { éléments ? : EventParams ['articles']; item_list_name ? : EventParams ['item_list_name']; item_list_id ? : EventParams ['item_list_id']; [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .

Signature:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'select_promotion' | 'view_promotion', eventParams?: {
    items?: EventParams['items'];
    promotion_id?: EventParams['promotion_id'];
    promotion_name?: EventParams['promotion_name'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement 'select_promotion' | 'view_promotion'
eventParams { éléments ? : EventParams ['articles']; promotion_id ? : EventParams ['id_promotion']; nom_promotion ? : EventParams ['nom_promotion'] ; [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .

Signature:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'set_checkout_option', eventParams?: {
    checkout_step?: EventParams['checkout_step'];
    checkout_option?: EventParams['checkout_option'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement 'set_checkout_option'
eventParams { checkout_step ? : EventParams ['checkout_step']; checkout_option ? : EventParams ['checkout_option']; [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .

Signature:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'share', eventParams?: {
    method?: EventParams['method'];
    content_type?: EventParams['content_type'];
    item_id?: EventParams['item_id'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement 'partager'
eventParams { méthode ? : EventParams ['méthode']; content_type? : EventParams ['content_type']; item_id? : EventParams ['ID de l'article']; [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .

Signature:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'sign_up', eventParams?: {
    method?: EventParams['method'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement 's'inscrire'
eventParams { méthode ? : EventParams ['méthode']; [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .

Signature:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'timing_complete', eventParams?: {
    name: string;
    value: number;
    event_category?: string;
    event_label?: string;
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement 'timing_complete'
eventParams { nom : chaîne ; valeur : nombre ; event_category?: chaîne ; event_label?: chaîne; [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .

Signature:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'add_shipping_info', eventParams?: {
    coupon?: EventParams['coupon'];
    currency?: EventParams['currency'];
    items?: EventParams['items'];
    shipping_tier?: EventParams['shipping_tier'];
    value?: EventParams['value'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement 'add_shipping_info'
eventParams { coupon ? : EventParams ['coupon']; devise ? : EventParams ['devise']; éléments ? : EventParams ['articles']; shipping_tier ? : EventParams ['shipping_tier']; valeur ? : EventParams ['valeur']; [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .

Signature:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'view_cart' | 'view_item', eventParams?: {
    currency?: EventParams['currency'];
    items?: EventParams['items'];
    value?: EventParams['value'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement 'view_cart' | 'Regarder l'objet'
eventParams { devise ? : EventParams ['devise']; éléments ? : EventParams ['articles']; valeur ? : EventParams ['valeur']; [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .

Signature:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'view_item_list', eventParams?: {
    items?: EventParams['items'];
    item_list_name?: EventParams['item_list_name'];
    item_list_id?: EventParams['item_list_id'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement 'view_item_list'
eventParams { éléments ? : EventParams ['articles']; item_list_name ? : EventParams ['item_list_name']; item_list_id ? : EventParams ['item_list_id']; [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .

Signature:

export declare function logEvent<T extends string>(analyticsInstance: Analytics, eventName: CustomEventName<T>, eventParams?: {
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement Nom de l'événement personnalisé <T>
eventParams { [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .

Signature:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'add_to_cart' | 'add_to_wishlist' | 'remove_from_cart', eventParams?: {
    currency?: EventParams['currency'];
    value?: EventParams['value'];
    items?: EventParams['items'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement 'add_to_cart' | 'add_to_wishlist' | 'remove_from_cart'
eventParams { devise ? : EventParams ['devise']; valeur ? : EventParams ['valeur']; éléments ? : EventParams ['articles']; [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .

Signature:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'begin_checkout', eventParams?: {
    currency?: EventParams['currency'];
    coupon?: EventParams['coupon'];
    value?: EventParams['value'];
    items?: EventParams['items'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement 'begin_checkout'
eventParams { devise ? : EventParams ['devise']; coupon ? : EventParams ['coupon']; valeur ? : EventParams ['valeur']; éléments ? : EventParams ['articles']; [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .

Signature:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'checkout_progress', eventParams?: {
    currency?: EventParams['currency'];
    coupon?: EventParams['coupon'];
    value?: EventParams['value'];
    items?: EventParams['items'];
    checkout_step?: EventParams['checkout_step'];
    checkout_option?: EventParams['checkout_option'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement 'checkout_progress'
eventParams { devise ? : EventParams ['devise']; coupon ? : EventParams ['coupon']; valeur ? : EventParams ['valeur']; éléments ? : EventParams ['articles']; checkout_step ? : EventParams ['checkout_step']; checkout_option ? : EventParams ['checkout_option']; [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

Voir Exceptions aux mesures .

Signature:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'exception', eventParams?: {
    description?: EventParams['description'];
    fatal?: EventParams['fatal'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement 'exception'
eventParams { description ? : Paramètres d'événement ['description']; fatal ? : EventParams ['fatal']; [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .

Signature:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'generate_lead', eventParams?: {
    value?: EventParams['value'];
    currency?: EventParams['currency'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement 'générer_lead'
eventParams {valeur ? : EventParams ['valeur']; devise ? : EventParams ['devise']; [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

La liste des paramètres d'événement recommandés est disponible dans la documentation de référence GA4. .

Signature:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'login', eventParams?: {
    method?: EventParams['method'];
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement 'se connecter'
eventParams { méthode ? : EventParams ['méthode']; [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

logEvent (analyticsInstance, eventName, eventParams, options)

Envoie un événement Google Analytics avec eventParams donné . Cette méthode associe automatiquement cet événement enregistré à cette instance d'application Web Firebase sur cet appareil.

Voir Pages vues .

Signature:

export declare function logEvent(analyticsInstance: Analytics, eventName: 'page_view', eventParams?: {
    page_title?: string;
    page_location?: string;
    page_path?: string;
    [key: string]: any;
}, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
Nom de l'événement 'page_view'
eventParams { titre_page ? : chaîne ; emplacement_page ? : chaîne ; chemin_page ? : chaîne ; [clé : chaîne] : n'importe lequel ; }
choix Options d'appel d'analyse

Retour:

vide

setAnalyticsCollectionEnabled (analyticsInstance, activé)

Définit si la collecte Google Analytics est activée pour cette application sur cet appareil. Définit window['ga-disable-analyticsId'] = true;

Signature:

export declare function setAnalyticsCollectionEnabled(analyticsInstance: Analytics, enabled: boolean): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique L'instance Analytics .
activé booléen Si vrai, active la collecte, si faux, la désactive.

Retour:

vide

setCurrentScreen (analyticsInstance, screenName, options)

Utiliser avec eventName comme 'screen_view' et ajouter eventParams pertinents . Voir les vues d'écran de suivi .

Utilisez la commande gtag config pour définir screen_name .

Signature:

export declare function setCurrentScreen(analyticsInstance: Analytics, screenName: string, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique L'instance Analytics .
Nom d'écran chaîne Nom d’écran à définir.
choix Options d'appel d'analyse

Retour:

vide

setUserId (analyticsInstance, identifiant, options)

Utilisez la commande gtag config pour définir user_id .

Signature:

export declare function setUserId(analyticsInstance: Analytics, id: string | null, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique L'instance Analytics .
identifiant chaîne | nul ID utilisateur à définir.
choix Options d'appel d'analyse

Retour:

vide

setUserProperties (analyticsInstance, propriétés, options)

Utilisez la commande gtag config pour définir tous les paramètres spécifiés.

Signature:

export declare function setUserProperties(analyticsInstance: Analytics, properties: CustomParams, options?: AnalyticsCallOptions): void;

Paramètres

Paramètre Taper Description
analyseInstance Analytique
propriétés Paramètres personnalisés
choix Options d'appel d'analyse

Retour:

vide

fonction()

est pris en charge()

Il s'agit d'une méthode statique publique fournie aux utilisateurs qui encapsule quatre vérifications différentes :

  1. Vérifiez s'il ne s'agit pas d'un environnement d'extension de navigateur. 2. Vérifiez si les cookies sont activés dans le navigateur actuel. 3. Vérifiez si IndexedDB est pris en charge par l'environnement du navigateur. 4. Vérifiez si le contexte actuel du navigateur est valide pour utiliser IndexedDB.open() .

Signature:

export declare function isSupported(): Promise<boolean>;

Retour:

Promesse<booléen>

fonction (consentSettings, ...)

setConsent(consentSettings)

Définit l'état de consentement de l'utilisateur final applicable pour cette application Web sur toutes les références gtag une fois Firebase Analytics initialisé.

Utilisez ConsentSettings pour spécifier des valeurs de type de consentement individuelles. Par défaut, les types de consentement sont définis sur « accordé ».

Signature:

export declare function setConsent(consentSettings: ConsentSettings): void;

Paramètres

Paramètre Taper Description
consentementParamètres Paramètres de consentement Mappe l’état de consentement de l’utilisateur final applicable pour gtag.js.

Retour:

vide

fonction(customParams, ...)

setDefaultEventParameters(customParams)

Ajoute des données qui seront définies sur chaque événement enregistré à partir du SDK, y compris les événements automatiques. Avec la commande "set" de gtag, les valeurs transmises persistent sur la page actuelle et sont transmises avec tous les événements ultérieurs.

Signature:

export declare function setDefaultEventParameters(customParams: CustomParams): void;

Paramètres

Paramètre Taper Description
paramètres personnalisés Paramètres personnalisés Tous les paramètres personnalisés que l'utilisateur peut transmettre à gtag.js.

Retour:

vide

fonction(options, ...)

paramètres (options)

Configure Firebase Analytics pour utiliser des noms gtag ou dataLayer personnalisés. Destiné à être utilisé si le script gtag.js a été installé sur cette page indépendamment de Firebase Analytics et utilise des noms autres que ceux par défaut pour la fonction gtag ou pour dataLayer . . Doit être appelé avant d'appeler getAnalytics() sinon cela n'aura aucun effet.

Signature:

export declare function settings(options: SettingsOptions): void;

Paramètres

Paramètre Taper Description
choix ParamètresOptions Noms gtag et dataLayer personnalisés.

Retour:

vide

ConsentStatusString

Si un type de consentement particulier a été accordé ou refusé.

Signature:

export declare type ConsentStatusString = 'granted' | 'denied';

Devise

Type de devise standard de Google Analytics.

Signature:

export declare type Currency = string | number;

Nom de l'événement personnalisé

Toute chaîne de nom d'événement personnalisé ne figurant pas dans la liste standard des noms d'événements recommandés.

Signature:

export declare type CustomEventName<T> = T extends EventNameString ? never : T;

ChaîneNomÉvénement

Saisissez les noms d'événements Google Analytics standard. logEvent accepte également n'importe quelle chaîne personnalisée et l'interprète comme un nom d'événement personnalisé.

Signature:

export declare type EventNameString = 'add_payment_info' | 'add_shipping_info' | 'add_to_cart' | 'add_to_wishlist' | 'begin_checkout' | 'checkout_progress' | 'exception' | 'generate_lead' | 'login' | 'page_view' | 'purchase' | 'refund' | 'remove_from_cart' | 'screen_view' | 'search' | 'select_content' | 'select_item' | 'select_promotion' | 'set_checkout_option' | 'share' | 'sign_up' | 'timing_complete' | 'view_cart' | 'view_item' | 'view_item_list' | 'view_promotion' | 'view_search_results';