Этот модуль используется для идентификации пользователей и изменения свойств профиля пользователя (задать, задать один раз, добавить, увеличить, удалить).

Чтобы узнать больше об управлении данными пользователей в интерфейсе OpenReplay, посетите раздел Управление данными.

Доступно по адресу:

tracker.analytics.people

Псевдоним верхнего уровня: tracker.analytics.identify(...) → то же самое, что и tracker.analytics.people.identify(...)

// Identify a user (required before other operations except reset)
tracker.analytics.people.identify(user_id: string, options?: { fromTracker: boolean }): void

// Reset local user context & properties (optionally, destroy device id)
// should be called on logout and session end
tracker.analytics.people.reset(hard?: boolean): void

// Delete user on backend, then reset local properties
tracker.analytics.people.deleteUser(): void

// Set properties (overwrite existing values)
tracker.analytics.people.setProperties(properties: Record<string, string | number>): void
tracker.analytics.people.setProperties(key: string, value: string | number): void

// Set properties only if they don't exist yet
tracker.analytics.people.setPropertiesOnce(properties: Record<string, string | number>): void

// Append values to an existing property (string becomes array)
tracker.analytics.people.appendValues(key: string, value: string | number): void

// Append value only if it’s not already present (requires property to exist locally)
tracker.analytics.people.appendUniqueValues(key: string, value: string | number): void

// Increment (or decrement) a numeric property
tracker.analytics.people.increment(key: string, value: number): void

// Read current user id
tracker.analytics.people.user_id: string | null | undefined

Идентифицирует текущего пользователя по строковому id (email, имя пользователя, внутренний id и т. д.) и помещает событие идентификации в очередь.

tracker.analytics.people.identify("nikita@openreplay.com")

Если ранее уже был идентифицирован другой пользователь, SDK сбрасывает локальные свойства people перед переключением на новый id.

options.fromTracker используется внутренне, чтобы избежать двойного вызова хука id на уровне трекера; как правило, он вам не нужен.

Сбрасывает id текущего пользователя и все локальные свойства people.

// soft reset
tracker.analytics.people.reset()

// hard reset (also clears persistent device id)
tracker.analytics.people.reset(true)

Удаляет текущего идентифицированного пользователя на бэкенде (отправляя мутацию удаления), а затем очищает локальное состояние.

tracker.analytics.people.deleteUser()

Если пользователь не идентифицирован, вызов не выполняет никаких действий.

После этого вызова user_id будет очищен, а локальные свойства будут удалены.

Задаёт свойства пользователя, перезаписывая существующие значения.

tracker.analytics.people.setProperties({
	plan: "pro",
	seats: 5,
})

// or key/value
tracker.analytics.people.setProperties("plan", "enterprise")

Зарезервированные/стандартные ключи (внутренние ключи трекера) игнорируются для локального кэша SDK.

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

Задаёт свойства только в том случае, если они ещё не существуют (с локальной точки зрения SDK).

tracker.analytics.people.setPropertiesOnce({
	signup_source: "docs",
	first_seen_at: Date.now(),
})

Локально будут записаны только те свойства, которых ещё нет в локальном кэше people.

Событие мутации setPropertyOnce всё равно помещается в очередь с переданными вами свойствами.

Добавляет значение к существующему свойству. Если свойство в данный момент является строкой/числом, оно становится массивом.

// start with something
tracker.analytics.people.setProperties({ tags: "new" })

// append
tracker.analytics.people.appendValues("tags", "beta-user")

SDK обновляет локальный кэш только в том случае, если это свойство уже существует локально.

Событие мутации добавления всегда помещается в очередь.

Добавляет значение только в том случае, если оно ещё отсутствует.

tracker.analytics.people.setProperties({ tags: ["new"] })
tracker.analytics.people.appendUniqueValues("tags", "new") // no change
tracker.analytics.people.appendUniqueValues("tags", "beta-user") // appended

Если свойство ещё не существует локально, этот вызов ничего не делает (возвращается досрочно). Сначала задайте его с помощью setProperties / setPropertiesOnce.

Добавляет число (в том числе отрицательные значения) к числовому свойству.

tracker.analytics.people.increment("logins", 1)
tracker.analytics.people.increment("credits", -10)

Если свойство не существует локально, перед увеличением оно инициализируется значением 0.

Если свойство существует, но не является числовым, SDK выбрасывает ошибку.

Все методы поддерживают слой совместимости, предоставляемый для удобства привыкших к ним пользователей:

tracker.analytics.people.set // setProperties
tracker.analytics.people.set_once // setPropertiesOnce
tracker.analytics.people.append // appendValues
tracker.analytics.people.union // appendUniqueValues
tracker.analytics.people.incrementBy // increment

Типичный поток

tracker.analytics.people.identify("user_123")

tracker.analytics.people.setProperties({
	email: "user@example.com",
	plan: "pro",
})

tracker.analytics.people.increment("sessions", 1)
tracker.analytics.people.appendUniqueValues("features_used", "analytics")

Имейте в виду, что начиная с версии 1.24.0 сессии OpenReplay поддерживают только одного пользователя, а это значит, что новый пользователь перезаписывает предыдущего в сессии. При переключении пользователей перезапускайте трекер также с опцией forceNew.

tracker.analytics.people.identify("user_a")
tracker.analytics.people.setProperties({ plan: "free" })

// switching user resets local people properties automatically
tracker.analytics.people.identify("user_b")

Если у вас возникнут какие-либо проблемы, присоединяйтесь к нашему Slack или загляните на наш Форум и получите помощь от нашего сообщества.