SDK аналитики трекера
SDK аналитики
Section titled SDK аналитикиУзнайте, как настроить SDK аналитики трекера OpenReplay.
Включение SDK
Section titled Включение SDKSDK аналитики включается по желанию (opt-in). Он создаётся только в том случае, если вы передаёте analytics.active в конструктор трекера — до этого tracker.analytics равен null, а tracker.track() ничего не делает.
import Tracker from '@openreplay/tracker'
const tracker = new Tracker({
projectKey: "YOUR_PROJECT_KEY",
analytics: { active: true },
})
tracker.start()
Параметры
Section titled Параметрыactive: booleanВключает SDK аналитики. По умолчанию:false.ingestPoint?: stringЭндпоинт, на который отправляются пакеты аналитики. Только для self-hosted развёртываний — в OpenReplay Cloud этот параметр игнорируется и используетсяhttps://api.openreplay.com/ingest. По умолчанию используетсяingestPointтрекера.
Модули
Section titled МодулиЧтобы узнать больше об управлении данными аналитики в интерфейсе OpenReplay, посетите Управление данными.
Сигнатуры верхнего уровня
Section titled Сигнатуры верхнего уровня// Identify a user with an id (e.g. email, username, etc.)
tracker.analytics.identify(userId: string): void
// same as
tracker.analytics.people.identify(userId)
// Add event to batch with option to send it immediately
tracker.analytics.track(eventName: string, tempProperties?: Record<string, any>, options?: { send_immediately: boolean })
// same as
tracker.analytics.events.track(eventName, tempProperties, options)
// Clear user id, people properties and super properties, and stop the batcher
tracker.analytics.reset(): void
Сокращённые методы на уровне трекера
Section titled Сокращённые методы на уровне трекераЭти методы находятся непосредственно в трекере, поэтому их можно безопасно вызывать, не обращаясь к tracker.analytics (пока аналитика отключена, они ничего не делают):
// Same as tracker.analytics.track(...)
tracker.track(eventName: string, properties?: Record<string, any>, options?: { send_immediately: boolean })
// Sets the replay's user ID *and* calls analytics.people.identify() with it
tracker.setUserID(id: string): void
tracker.identify(id: string): void // alias of setUserID
// Send analytics events under your own token, without session recording
tracker.setAnalyticsToken(token: string): void
reset
Section titled resetОчищает идентифицированного пользователя (включая постоянный идентификатор устройства), все свойства people, все суперсвойства и останавливает отправку пакетов. Вызывайте этот метод при выходе из системы.
tracker.analytics.reset()
Остались вопросы?
Section titled Остались вопросы?Если у вас возникнут какие-либо проблемы, подключайтесь к нашему Slack или загляните на наш Форум и получите помощь от нашего сообщества.