analytics package

Веб-SDK Firebase Analytics. Этот SDK не работает в среде Node.js.

Функции

Функция Описание
функция (приложение, ...)
getAnalytics (приложение) Возвращает экземпляр Analytics для данного приложения.
инициализироватьAnalytics (приложение, параметры) Возвращает экземпляр Analytics для данного приложения.
функция (экземпляр аналитики, ...)
getGoogleAnalyticsClientId(analyticsInstance) Получает уникальный идентификатор Google Analytics для веб-клиента. См. client_id .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. Список рекомендуемых параметров событий можно найти в справочной документации GA4. .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. Список рекомендуемых параметров событий можно найти в справочной документации GA4. .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. См. Отслеживание просмотров экрана .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. Список рекомендуемых параметров событий можно найти в справочной документации GA4. .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. Список рекомендуемых параметров событий можно найти в справочной документации GA4. .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. Список рекомендуемых параметров событий можно найти в справочной документации GA4. .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. Список рекомендуемых параметров событий можно найти в справочной документации GA4. .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. Список рекомендуемых параметров событий можно найти в справочной документации GA4. .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. Список рекомендуемых параметров событий можно найти в справочной документации GA4. .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. Список рекомендуемых параметров событий можно найти в справочной документации GA4. .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. Список рекомендуемых параметров событий можно найти в справочной документации GA4. .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. Список рекомендуемых параметров событий можно найти в справочной документации GA4. .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. Список рекомендуемых параметров событий можно найти в справочной документации GA4. .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. Список рекомендуемых параметров событий можно найти в справочной документации GA4. .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. Список рекомендуемых параметров событий можно найти в справочной документации GA4. .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. Список рекомендуемых параметров событий можно найти в справочной документации GA4. .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. Список рекомендуемых параметров событий можно найти в справочной документации GA4. .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. Список рекомендуемых параметров событий можно найти в справочной документации GA4. .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. См. Измерение исключений. .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. Список рекомендуемых параметров событий можно найти в справочной документации GA4. .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. Список рекомендуемых параметров событий можно найти в справочной документации GA4. .
logEvent(analyticsInstance, eventName, eventParams, options) Отправляет событие Google Analytics с заданным eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве. Посмотреть просмотры страниц .
setAnalyticsCollectionEnabled (analyticsInstance, включено) Определяет, включен ли сбор Google Analytics для этого приложения на этом устройстве. Устанавливает глобальное window['ga-disable-analyticsId'] = true;
setCurrentScreen (analyticsInstance, screenName, параметры) Используйте команду gtag config , чтобы установить screen_name .
setUserId(analyticsInstance, id, параметры) Используйте команду gtag config чтобы установить user_id .
setUserProperties (analyticsInstance, свойства, параметры) Используйте команду gtag config чтобы установить все указанные параметры.
функция()
isSupported() Это общедоступный статический метод, предоставляемый пользователям и заключающий в себе четыре различные проверки: 1. Проверьте, не является ли это средой расширения браузера. 2. Проверьте, включены ли файлы cookie в текущем браузере. 3. Проверьте, поддерживается ли IndexedDB средой браузера. 4. Проверьте, действителен ли текущий контекст браузера для использования IndexedDB.open() .
функция (настройки согласия, ...)
setConsent (Настройки согласия) Устанавливает применимое состояние согласия конечного пользователя для этого веб-приложения для всех ссылок на gtag после инициализации Firebase Analytics. Используйте ConsentSettings , чтобы указать отдельные значения типа согласия. По умолчанию для типов согласия установлено значение «предоставлено».
функция (customParams, ...)
setDefaultEventParameters (customParams) Добавляет данные, которые будут установлены для каждого события, регистрируемого из SDK, включая автоматические. С помощью команды gtag «set» переданные значения сохраняются на текущей странице и передаются со всеми последующими событиями.
функция(опции, ...)
настройки (опции) Настраивает Firebase Analytics для использования пользовательских имен gtag или dataLayer . Предназначен для использования, если скрипт gtag.js установлен на этой странице независимо от Firebase Analytics и использует имена, отличные от значений по умолчанию, для функции gtag или для dataLayer . Должен быть вызван перед вызовом getAnalytics() , иначе он не будет иметь никакого эффекта.

Интерфейсы

Интерфейс Описание
Аналитика Экземпляр Firebase Analytics.
АналитикаCallOptions Дополнительные параметры, которые можно передать вызовам методов Analytics, например logEvent и т. д.
Настройки аналитики Параметры инициализации экземпляра Analytics .
Настройки согласия Настройки статуса согласия для каждого типа согласия. Дополнительную информацию о состоянии и типах согласия можно найти в справочной документации GA4. .
ControlParams Стандартные параметры управления gtag.js Дополнительную информацию см. в справочной документации GA4. .
CustomParams Любые пользовательские параметры, которые пользователь может передать в gtag .
EventParams Стандартные параметры событий gtag.js Дополнительную информацию см. в справочной документации GA4. .
GtagConfigParams Набор общих настроек конфигурации Google Analytics, распознаваемых gtag.js .
Элемент Стандартный тип Item Google Analytics.
Повышение Поле, ранее использовавшееся некоторыми событиями Google Analytics.
НастройкиОпции Указывает пользовательские параметры для вашего экземпляра Firebase Analytics. Вы должны установить их перед инициализацией firebase.analytics() .

Введите псевдонимы

Введите псевдоним Описание
ConsentStatusString Был ли предоставлен или отклонен определенный тип согласия.
Валюта Стандартный тип валюты Google Analytics.
CustomEventName Любая строка имени пользовательского события, отсутствующая в стандартном списке рекомендуемых имен событий.
EventNameString Введите стандартные названия событий Google Analytics. logEvent также принимает любую пользовательскую строку и интерпретирует ее как имя пользовательского события.

функция (приложение, ...)

getAnalytics (приложение)

Возвращает экземпляр Analytics для данного приложения.

Подпись:

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

Параметры

Параметр Тип Описание
приложение FirebaseApp Используемое приложение FirebaseApp .

Возврат:

Аналитика

инициализироватьAnalytics (приложение, параметры)

Возвращает экземпляр Analytics для данного приложения.

Подпись:

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

Параметры

Параметр Тип Описание
приложение FirebaseApp Используемое приложение FirebaseApp .
параметры Настройки аналитики

Возврат:

Аналитика

функция (экземпляр аналитики, ...)

getGoogleAnalyticsClientId(analyticsInstance)

Получает уникальный идентификатор Google Analytics для веб-клиента. См. client_id .

Подпись:

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

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика

Возврат:

Обещание<строка>

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

Список рекомендуемых параметров событий можно найти в справочной документации GA4. .

Подпись:

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;

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события 'add_pay_info'
eventParams {купон?: EventParams ['купон']; валюта?: EventParams ['валюта']; предметы?: EventParams ['предметы']; тип_платежа?: EventParams ['тип_платежа']; значение?: EventParams ['ценить']; [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

Список рекомендуемых параметров событий можно найти в справочной документации GA4. .

Подпись:

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;

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события 'покупка' | 'возвращать деньги'
eventParams {значение?: EventParams ['ценить']; валюта?: EventParams ['валюта']; идентификатор транзакции: EventParams ['transaction_id']; налог?: EventParams ['налог']; доставка?: EventParams ['перевозки']; предметы?: EventParams ['предметы']; купон?: EventParams ['купон']; принадлежность?: EventParams ['принадлежность']; [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

См. Отслеживание просмотров экрана .

Подпись:

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;

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события 'screen_view'
eventParams { firebase_screen: EventParams ['firebase_screen']; firebase_screen_class: EventParams ['firebase_screen_class']; [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

Список рекомендуемых параметров событий можно найти в справочной документации GA4. .

Подпись:

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

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события 'поиск' | 'view_search_results'
eventParams { search_term?: EventParams ['искомый_терм']; [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

Список рекомендуемых параметров событий можно найти в справочной документации GA4. .

Подпись:

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;

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события 'выбрать_контент'
eventParams {content_type?: EventParams ['тип_контента']; item_id?: EventParams ['item_id']; [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

Список рекомендуемых параметров событий можно найти в справочной документации GA4. .

Подпись:

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;

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события 'выбрать_элемент'
eventParams { элементы?: EventParams ['предметы']; имя_списка_элементов?: EventParams ['имя_списка_элементов']; item_list_id?: EventParams ['item_list_id']; [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

Список рекомендуемых параметров событий можно найти в справочной документации GA4. .

Подпись: 

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;

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события 'select_promotion' | 'view_promotion'
eventParams { элементы?: EventParams ['предметы']; Promotion_id?: EventParams ['promotion_id']; имя_продвижения?: EventParams ['имя_продвижения']; [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

Список рекомендуемых параметров событий можно найти в справочной документации GA4. .

Подпись: 

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;

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события 'set_checkout_option'
eventParams { checkout_step?: EventParams ['checkout_step']; checkout_option?: EventParams ['checkout_option']; [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

Список рекомендуемых параметров событий можно найти в справочной документации GA4. .

Подпись: 

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;

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события 'делиться'
eventParams { метод?: EventParams ['метод']; content_type?: EventParams ['тип_контента']; item_id?: EventParams ['item_id']; [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

Список рекомендуемых параметров событий можно найти в справочной документации GA4. .

Подпись: 

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

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события 'зарегистрироваться'
eventParams { метод?: EventParams ['метод']; [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

Список рекомендуемых параметров событий можно найти в справочной документации GA4. .

Подпись: 

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;

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события 'time_complete'
eventParams {имя: строка; значение: число; event_category?: строка; event_label?: строка; [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

Список рекомендуемых параметров событий можно найти в справочной документации GA4. .

Подпись: 

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;

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события 'add_shipping_info'
eventParams {купон?: EventParams ['купон']; валюта?: EventParams ['валюта']; предметы?: EventParams ['предметы']; Shipping_tier?: EventParams ['уровень_доставки']; значение?: EventParams ['ценить']; [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

Список рекомендуемых параметров событий можно найти в справочной документации GA4. .

Подпись: 

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;

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события 'просмотр_карты' | 'view_item'
eventParams { валюта?: EventParams ['валюта']; предметы?: EventParams ['предметы']; значение?: EventParams ['ценить']; [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

Список рекомендуемых параметров событий можно найти в справочной документации GA4. .

Подпись: 

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;

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события 'view_item_list'
eventParams { элементы?: EventParams ['предметы']; имя_списка_элементов?: EventParams ['имя_списка_элементов']; item_list_id?: EventParams ['item_list_id']; [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

Список рекомендуемых параметров событий можно найти в справочной документации GA4. .

Подпись: 

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

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события CustomEventName <Т>
eventParams { [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

Список рекомендуемых параметров событий можно найти в справочной документации GA4. .

Подпись: 

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;

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события 'добавить_в_корзину' | 'add_to_wishlist' | 'remove_from_cart'
eventParams { валюта?: EventParams ['валюта']; значение?: EventParams ['ценить']; предметы?: EventParams ['предметы']; [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

Список рекомендуемых параметров событий можно найти в справочной документации GA4. .

Подпись: 

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;

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события 'begin_checkout'
eventParams { валюта?: EventParams ['валюта']; купон?: EventParams ['купон']; значение?: EventParams ['ценить']; предметы?: EventParams ['предметы']; [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

Список рекомендуемых параметров событий можно найти в справочной документации GA4. .

Подпись: 

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;

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события 'checkout_progress'
eventParams { валюта?: EventParams ['валюта']; купон?: EventParams ['купон']; значение?: EventParams ['ценить']; предметы?: EventParams ['предметы']; checkout_step?: EventParams ['checkout_step']; checkout_option?: EventParams ['checkout_option']; [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

См. Измерение исключений. .

Подпись: 

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

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события 'исключение'
eventParams { описание?: EventParams ['описание']; фатально?: EventParams ['фатальный']; [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

Список рекомендуемых параметров событий можно найти в справочной документации GA4. .

Подпись: 

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

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события 'generate_lead'
eventParams {значение?: EventParams ['ценить']; валюта?: EventParams ['валюта']; [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

Список рекомендуемых параметров событий можно найти в справочной документации GA4. .

Подпись: 

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

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события 'авторизоваться'
eventParams { метод?: EventParams ['метод']; [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

logEvent(analyticsInstance, eventName, eventParams, options)

Отправляет событие Google Analytics с заданными eventParams . Этот метод автоматически связывает это зарегистрированное событие с этим экземпляром веб-приложения Firebase на этом устройстве.

Посмотреть просмотры страниц .

Подпись: 

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;

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
имя события 'просмотр_страницы'
eventParams { page_title?: строка; page_location?: строка; путь_страницы?: строка; [ключ: строка]: любой; }
параметры АналитикаCallOptions

Возврат:

пустота

setAnalyticsCollectionEnabled (analyticsInstance, включено)

Определяет, включен ли сбор Google Analytics для этого приложения на этом устройстве. Устанавливает глобальное window['ga-disable-analyticsId'] = true;

Подпись: 

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

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика Экземпляр Google Analytics .
включено логическое значение Если true, сбор данных включается, если false — отключает его.

Возврат:

пустота

setCurrentScreen (analyticsInstance, screenName, параметры)

Используйте с eventName как «screen_view» и добавьте соответствующие eventParams . См. Отслеживание просмотров экрана .

Используйте команду config gtag, чтобы установить screen_name .

Подпись: 

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

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика Экземпляр Google Analytics .
Ник нить Имя экрана, которое нужно установить.
параметры АналитикаCallOptions

Возврат:

пустота

setUserId(analyticsInstance, id, параметры)

Используйте команду config gtag, чтобы установить user_id .

Подпись: 

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

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика Экземпляр Google Analytics .
идентификатор строка | нулевой Идентификатор пользователя для установки.
параметры АналитикаCallOptions

Возврат:

пустота

setUserProperties (analyticsInstance, свойства, параметры)

Используйте команду gtag config чтобы установить все указанные параметры.

Подпись: 

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

Параметры

Параметр Тип Описание
аналитикаЭкземпляр Аналитика
характеристики CustomParams
параметры АналитикаCallOptions

Возврат:

пустота

функция()

isSupported()

Это общедоступный статический метод, предоставляемый пользователям и заключающий в себе четыре различные проверки:

  1. Проверьте, не является ли это средой расширения браузера. 2. Проверьте, включены ли файлы cookie в текущем браузере. 3. Проверьте, поддерживается ли IndexedDB средой браузера. 4. Проверьте, действителен ли текущий контекст браузера для использования IndexedDB.open() .

Подпись: 

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

Возврат:

Обещание <логическое значение>

функция (настройки согласия, ...)

setConsent (Настройки согласия)

Устанавливает применимое состояние согласия конечного пользователя для этого веб-приложения для всех ссылок на gtag после инициализации Firebase Analytics.

Используйте ConsentSettings , чтобы указать отдельные значения типа согласия. По умолчанию для типов согласия установлено значение «предоставлено».

Подпись: 

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

Параметры

Параметр Тип Описание
согласиеНастройки Настройки согласия Сопоставляет применимое состояние согласия конечного пользователя для gtag.js.

Возврат:

пустота

функция (customParams, ...)

setDefaultEventParameters (customParams)

Добавляет данные, которые будут установлены для каждого события, регистрируемого из SDK, включая автоматические. С помощью команды gtag «set» переданные значения сохраняются на текущей странице и передаются со всеми последующими событиями.

Подпись: 

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

Параметры

Параметр Тип Описание
CustomParams CustomParams Любые пользовательские параметры, которые пользователь может передать в gtag.js.

Возврат:

пустота

функция(опции, ...)

настройки (опции)

Настраивает Firebase Analytics для использования пользовательских имен gtag или dataLayer . Предназначен для использования, если скрипт gtag.js установлен на этой странице независимо от Firebase Analytics и использует имена, отличные от значений по умолчанию, для функции gtag или для dataLayer . Должен быть вызван перед вызовом getAnalytics() , иначе он не будет иметь никакого эффекта.

Подпись: 

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

Параметры

Параметр Тип Описание
параметры НастройкиОпции Пользовательские названия gtag и dataLayer.

Возврат:

пустота

ConsentStatusString

Был ли предоставлен или отклонен определенный тип согласия.

Подпись: 

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

Валюта

Стандартный тип валюты Google Analytics.

Подпись: 

export declare type Currency = string | number;

CustomEventName

Любая строка имени пользовательского события, отсутствующая в стандартном списке рекомендуемых имен событий.

Подпись: 

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

EventNameString

Введите стандартные названия событий Google Analytics. logEvent также принимает любую пользовательскую строку и интерпретирует ее как имя пользовательского события.

Подпись: 

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