analytics package

Firebase Analytics Web SDK'sı. Bu SDK, Node.js ortamında çalışmaz.

İşlevler

Arayüzler

Tür Takma Adları

function(uygulama; ...)

getAnalytics(uygulama)

Belirtilen uygulama için bir Analytics örneği döndürür.

İmza:

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

Parametreler

Şunu döndürür:

Analizler

startizeAnalytics(uygulama, seçenekler)

Belirtilen uygulama için bir Analytics örneği döndürür.

İmza:

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

Parametreler

Şunu döndürür:

Analizler

Functions(analyticsInstance, ...)

getGoogleAnalyticsClientId(analyticsInstance)

Web istemcisi için benzersiz bir Google Analytics tanımlayıcısı alır. client_id adlı istemciyi inceleyin.

İmza:

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

Parametreler

Şunu döndürür:

Promise<dize>

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

Önerilen etkinlik parametrelerinin listesini GA4 referans belgelerinde bulabilirsiniz.

İmza:

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;

Parametreler

Şunu döndürür:

geçersiz

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

Önerilen etkinlik parametrelerinin listesini GA4 referans belgelerinde bulabilirsiniz.

İmza:

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;

Parametreler

Şunu döndürür:

geçersiz

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

Ekran Görüntülemelerini İzleme bölümünü inceleyin.

İmza:

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;

Parametreler

Şunu döndürür:

geçersiz

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

Önerilen etkinlik parametrelerinin listesini GA4 referans belgelerinde bulabilirsiniz.

İmza:

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

Parametreler

Şunu döndürür:

geçersiz

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

Önerilen etkinlik parametrelerinin listesini GA4 referans belgelerinde bulabilirsiniz.

İmza:

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;

Parametreler

Şunu döndürür:

geçersiz

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

Önerilen etkinlik parametrelerinin listesini GA4 referans belgelerinde bulabilirsiniz.

İmza:

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;

Parametreler

Şunu döndürür:

geçersiz

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

Önerilen etkinlik parametrelerinin listesini GA4 referans belgelerinde bulabilirsiniz.

İmza:

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;

Parametreler

Şunu döndürür:

geçersiz

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

Önerilen etkinlik parametrelerinin listesini GA4 referans belgelerinde bulabilirsiniz.

İmza:

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;

Parametreler

Şunu döndürür:

geçersiz

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

Önerilen etkinlik parametrelerinin listesini GA4 referans belgelerinde bulabilirsiniz.

İmza:

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;

Parametreler

Şunu döndürür:

geçersiz

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

Önerilen etkinlik parametrelerinin listesini GA4 referans belgelerinde bulabilirsiniz.

İmza:

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

Parametreler

Şunu döndürür:

geçersiz

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

Önerilen etkinlik parametrelerinin listesini GA4 referans belgelerinde bulabilirsiniz.

İmza:

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;

Parametreler

Şunu döndürür:

geçersiz

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

Önerilen etkinlik parametrelerinin listesini GA4 referans belgelerinde bulabilirsiniz.

İmza:

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;

Parametreler

Şunu döndürür:

geçersiz

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

Önerilen etkinlik parametrelerinin listesini GA4 referans belgelerinde bulabilirsiniz.

İmza:

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;

Parametreler

Şunu döndürür:

geçersiz

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

Önerilen etkinlik parametrelerinin listesini GA4 referans belgelerinde bulabilirsiniz.

İmza:

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;

Parametreler

Şunu döndürür:

geçersiz

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

Önerilen etkinlik parametrelerinin listesini GA4 referans belgelerinde bulabilirsiniz.

İmza:

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

Parametreler

Şunu döndürür:

geçersiz

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

Önerilen etkinlik parametrelerinin listesini GA4 referans belgelerinde bulabilirsiniz.

İmza:

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;

Parametreler

Şunu döndürür:

geçersiz

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

Önerilen etkinlik parametrelerinin listesini GA4 referans belgelerinde bulabilirsiniz.

İmza:

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;

Parametreler

Şunu döndürür:

geçersiz

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

Önerilen etkinlik parametrelerinin listesini GA4 referans belgelerinde bulabilirsiniz.

İmza:

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;

Parametreler

Şunu döndürür:

geçersiz

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

İstisnaları ölçme bölümünü inceleyin.

İmza:

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

Parametreler

Şunu döndürür:

geçersiz

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

Önerilen etkinlik parametrelerinin listesini GA4 referans belgelerinde bulabilirsiniz.

İmza:

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

Parametreler

Şunu döndürür:

geçersiz

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

Önerilen etkinlik parametrelerinin listesini GA4 referans belgelerinde bulabilirsiniz.

İmza:

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

Parametreler

Şunu döndürür:

geçersiz

logEvent(analyticsInstance; eventName, eventParams, seçenekler)

Belirtilen eventParams ile bir Google Analytics etkinliği gönderir. Bu yöntem, kaydedilen bu etkinliği bu cihazdaki bu Firebase web uygulaması örneğiyle otomatik olarak ilişkilendirir.

Sayfa görüntülemeleri bölümünü inceleyin.

İmza:

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;

Parametreler

Şunu döndürür:

geçersiz

setAnalyticsCollectionEnabled(analyticsInstance, etkin)

Google Analytics koleksiyonunun bu cihazda bu uygulama için etkinleştirilip etkinleştirilmediğini belirler. Global olarak window['ga-disable-analyticsId'] = true; ayarlar

İmza:

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

Parametreler

Şunu döndürür:

geçersiz

setCurrentScreen(analyticsInstance, screenName, options)

"screen_view" olarak eventName ile kullan ve alakalı eventParams ekleyin. Ekran Görüntülemelerini İzleme bölümünü inceleyin.

screen_name ayarını yapmak için gtag config komutunu kullanın.

İmza:

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

Parametreler

Şunu döndürür:

geçersiz

setUserId(analyticsInstance; kimlik; options)

user_id ayarını yapmak için gtag config komutunu kullanın.

İmza:

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

Parametreler

Şunu döndürür:

geçersiz

setUserProperties(analyticsInstance, mülkler, seçenekler)

Belirtilen tüm parametreleri ayarlamak için gtag config komutunu kullanın.

İmza:

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

Parametreler

Şunu döndürür:

geçersiz

fonksiyon()

isDesteklenen()

Bu, kullanıcılara dört farklı kontrolü tamamlayan herkese açık bir statik yöntemdir:

1. Bunun bir tarayıcı uzantısı ortamı olup olmadığını kontrol edin. 2. Mevcut tarayıcıda çerezlerin etkin olup olmadığını kontrol edin. 3. IndexedDB'nin tarayıcı ortamı tarafından desteklenip desteklenmediğini kontrol edin. 4. Mevcut tarayıcı bağlamının IndexedDB.open() kullanımı için geçerli olup olmadığını kontrol edin.

İmza:

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

Şunu döndürür:

Promise&lt;boolean&gt;

function(consentSettings, ...)

setConsent(consentSettings)

Firebase Analytics başlatıldıktan sonra bu web uygulaması için tüm gtag referansları için geçerli son kullanıcı izin durumunu ayarlar.

Bağımsız izin türü değerlerini belirtmek için ConsentSettings seçeneğini kullanın. Varsayılan olarak izin türleri "granted" (izin verildi) değerine ayarlanır.

İmza:

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

Parametreler

Şunu döndürür:

geçersiz

function(customParams, ...)

setDefaultEventParameters(customParams)

Otomatik olanlar da dahil olmak üzere, SDK'dan kaydedilen her etkinlikte ayarlanacak verileri ekler. gtag "set" ile komutuna ayarlanırsa, aktarılan değerler geçerli sayfada kalır ve sonraki tüm etkinliklerle aktarılır.

İmza:

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

Parametreler

Şunu döndürür:

geçersiz

function(seçenekler; ...)

ayarlar(seçenekler)

Firebase Analytics'i özel gtag veya dataLayer adlarını kullanacak şekilde yapılandırır. Bu sayfaya Firebase Analytics'ten bağımsız olarak gtag.js komut dosyası yüklenmişse ve gtag işlevi veya dataLayer için varsayılan olmayan adlar kullanılıyorsa kullanılmalıdır. getAnalytics() çağrılmadan önce çağrılmalıdır. Aksi takdirde herhangi bir etkisi olmaz.

İmza:

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

Parametreler

Şunu döndürür:

geçersiz

ConsentStatusDizesi

Belirli bir izin türünün verilip verilmediği veya reddedildiği.

İmza:

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

Para Birimi

Standart Google Analytics para birimi türü.

İmza:

export declare type Currency = string | number;

ÖzelEtkinlikAdı

Standart önerilen etkinlik adları listesinde olmayan herhangi bir özel etkinlik adı dizesi.

İmza:

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

EtkinlikAdıDizesi

Standart Google Analytics etkinlik adları için tür. logEvent ayrıca özel dizeleri kabul eder ve bunu özel etkinlik adı olarak yorumlar.

İmza:

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';