@gluonjs/core / src/analytics / AnalyticsScope

Interface: AnalyticsScope

Properties

context

readonly context: Readonly<Record<string, unknown>>

Methods

child()

child(context): AnalyticsScope

Parameters

context

Readonly<Record<string, unknown>>

Returns

AnalyticsScope

---

impression()

impression<Payload>(key, name, payload, options?): AnalyticsEvent<Payload> | undefined

Type Parameters

Payload

Payload

Parameters

key

string

name

AnalyticsEventName

payload

Payload

options?

Omit<AnalyticsEventOptions, "dedupeKey">

Returns

AnalyticsEvent<Payload> | undefined

---

track()

track<Payload>(name, payload, options?): AnalyticsEvent<Payload> | undefined

Type Parameters

Payload

Payload

Parameters

name

AnalyticsEventName

payload

Payload

options?

AnalyticsEventOptions

Returns

AnalyticsEvent<Payload> | undefined

Example

Inherit analytics context through nested reusable components:

import { Analytics, createAnalytics, createGa4Adapter, createServerAnalytics, semanticAnalyticsEvents, trackEvent, trackImpression, type AnalyticsAdapter, type AnalyticsEvent, type AnalyticsEventName, type AnalyticsEventOptions, type AnalyticsOptions, type AnalyticsScope, type AnalyticsDirectiveOptions, type SemanticAnalyticsEvent } from '@gluonjs/core/analytics';
const adapter: AnalyticsAdapter = createGa4Adapter((event) => console.log(event));
const options: AnalyticsOptions = { adapters: [adapter], consent: () => 'granted' };
const analytics: Analytics = createAnalytics(options);
const scope: AnalyticsScope = analytics.scope({ locale: 'en-GB' });
const eventName: AnalyticsEventName = semanticAnalyticsEvents[0];
const semanticEvent: SemanticAnalyticsEvent = 'view_item';
const eventOptions: AnalyticsEventOptions = { context: { currency: 'EUR' } };
const event: AnalyticsEvent = scope.track(eventName, { item_id: 'lamp' }, eventOptions)!;
const directiveOptions: AnalyticsDirectiveOptions = { emitOnUpdate: true };
const server = createServerAnalytics();
console.log(event, semanticEvent, directiveOptions, server, trackEvent, trackImpression);