IKuznetsov: Новая страница: «= Пользовательские события = Ключ-АСТРОМ позволяет отправлять пользовательские события для отслеживания взаимодействий пользователей, бизнес-показателей и данных, специфичных для приложения. Вы также можете дополнить все события дополнительным кон...»

2026-08-19T17:53:54Z

Новая страница: «= Пользовательские события = Ключ-АСТРОМ позволяет отправлять пользовательские события для отслеживания взаимодействий пользователей, бизнес-показателей и данных, специфичных для приложения. Вы также можете дополнить все события дополнительным кон...»

Новая страница

= Пользовательские события =

Ключ-АСТРОМ позволяет отправлять пользовательские события для отслеживания взаимодействий пользователей, бизнес-показателей и данных, специфичных для приложения. Вы также можете дополнить все события дополнительным контекстом, используя модификаторы событий.

== Свойства событий и сессий ==

Прежде чем отправлять свойства событий или сессий из вашего приложения, необходимо сначала определить их в веб-интерфейсе Ключ-АСТРОМ. Любые свойства, которые не были предварительно настроены, будут отброшены.

Для определения нового свойства:

# В разделе '''Ключевые показатели опыта''' выберите интерфейс, для которого вы хотите добавить свойство.
# Выберите вкладку '''Настройки''', затем выберите '''Свойства событий и сессий'''.
# В зависимости от типа создаваемого свойства выберите пункт '''Добавить''' в разделе '''Определенные свойства события''' или '''Определенные свойства сессии'''.
# В поле '''Название поля''' введите название для вашего свойства (например, <code>cart.total_value</code>).
# (Необязательно) Чтобы сделать имя поля нечувствительным к регистру, включите параметр '''Проверка имени поля должна быть нечувствительной к регистру'''.
# В списке '''Тип данных''' выберите соответствующий тип данных для вашего свойства: <code>string</code>, <code>boolean</code> или <code>number</code>.

Ключ-АСТРОМ автоматически добавляет префикс к имени поля: <code>event_properties.</code> или <code>session_properties.</code> в зависимости от выбранного типа свойства. Например, имя поля <code>cart.total_value</code> станет <code>event_properties.cart.total_value</code>.

== Отправляйте пользовательские события ==

Используется <code>sendEvent()</code> для создания отчетов о пользовательских событиях с необязательными параметрами продолжительности и свойствами события.

=== Основное использование ===

'''Swift'''
<pre>
// Простое событие
Astromkey.sendEvent(DTXEventData())

// Событие с указанием длительности (в миллисекундах)
Astromkey.sendEvent(DTXEventData().withDuration(150))
</pre>

'''Objective-C'''
<pre>
// Простое событие
[Astromkey sendEvent:[[DTXEventData alloc] init]];

// Событие с указанием длительности (в миллисекундах)
[Astromkey sendEvent:[[[DTXEventData alloc] init] withDuration:@150]];
</pre>

=== Добавить свойства события ===

Добавьте пользовательские свойства для обеспечения контекста ваших событий. Ключи свойств должны начинаться с префикса <code>event_properties.</code>.

'''Swift'''
<pre>
Astromkey.sendEvent(
DTXEventData()
.withDuration(250)
.addEventProperty("event_properties.checkout_step", value: "payment_confirmed")
.addEventProperty("event_properties.cart_value", value: 149.99)
.addEventProperty("event_properties.item_count", value: 3)
)
</pre>

'''Objective-C'''
<pre>
[Astromkey sendEvent:[[[[[DTXEventData alloc] init]
withDuration:@250]
addEventProperty:@"event_properties.checkout_step" value:@"payment_confirmed"]
addEventProperty:@"event_properties.cart_value" value:@149.99]
addEventProperty:@"event_properties.item_count" value:@3]];
</pre>

=== Правила наименования свойств ===

Правила и ограничения именования см. в разделе «Свойства событий и сессий».

== Модификаторы событий ==

Модификаторы событий позволяют перехватывать и изменять все события до их отправки в Ключ-АСТРОМ. Используйте их для добавления общих свойств, удаления конфиденциальной информации или фильтрации событий.

=== Добавить модификатор события ===

'''Swift'''
<pre>
let subscriber = Astromkey.addEventModifier { event in
// Добавить отслеживание экспериментов для всех событий
event.fields["event_properties.experiment_id"] = "checkout_flow_v2"
event.fields["event_properties.variant"] = "treatment_a"
return event
}
</pre>

'''Objective-C'''
<pre>
DTXModifyEventSubscriber *subscriber = [Astromkey addEventModifier:^DTXModifyableEvent *(DTXModifyableEvent *event) {
// Добавить отслеживание экспериментов для всех событий
event.fields[@"event_properties.experiment_id"] = @"checkout_flow_v2";
event.fields[@"event_properties.variant"] = @"treatment_a";
return event;
}];
</pre>

=== Фильтрация событий ===

Вернуться <code>nil</code>, чтобы отменить событие:

'''Swift'''
<pre>
let subscriber = Astromkey.addEventModifier { event in
// Отфильтровывать события от тестовых пользователей
if event.fields["event_properties.is_test_user"] as? Bool == true {
return nil // Отбросить это событие
}
return event
}
</pre>

'''Objective-C'''
<pre>
DTXModifyEventSubscriber *subscriber = [Astromkey addEventModifier:^DTXModifyableEvent *(DTXModifyableEvent *event) {
// Отфильтровывать события от тестовых пользователей
if ([event.fields[@"event_properties.is_test_user"] boolValue]) {
return nil; // Отбросить это событие
}
return event;
}];
</pre>

=== Удалите конфиденциальные данные ===

'''Swift'''
<pre>
let subscriber = Astromkey.addEventModifier { event in
// Удаление идентификаторов пользователей из URL-адресов
if let url = event.fields["url.full"] as? String {
let redactedUrl = url.replacingOccurrences(
of: #"/users/\w+/"#,
with: "/users/{id}/",
options: .regularExpression
)
event.fields["url.full"] = redactedUrl
}
return event
}
</pre>

'''Objective-C'''
<pre>
DTXModifyEventSubscriber *subscriber = [Astromkey addEventModifier:^DTXModifyableEvent *(DTXModifyableEvent *event) {
// Удаление идентификаторов пользователей из URL-адресов
NSString *url = event.fields[@"url.full"];
if (url) {
NSRegularExpression *regex = [NSRegularExpression regularExpressionWithPattern:@"/users/\\w+/" options:0 error:nil];
NSString *redactedUrl = [regex stringByReplacingMatchesInString:url options:0 range:NSMakeRange(0, url.length) withTemplate:@"/users/{id}/"];
event.fields[@"url.full"] = redactedUrl;
}
return event;
}];
</pre>

=== Удалить модификаторы событий ===

'''Swift'''
<pre>
// Сохраняйте данные подписчика при добавлении модификатора
let subscriber = Astromkey.addEventModifier { event in
event.fields["event_properties.custom"] = "value"
return event
}

// Удалять, когда больше не требуется
Astromkey.removeEventModifier(subscriber)
</pre>

'''Objective-C'''
<pre>
// Сохраняйте данные подписчика при добавлении модификатора
DTXModifyEventSubscriber *subscriber = [Astromkey addEventModifier:^DTXModifyableEvent *(DTXModifyableEvent *event) {
event.fields[@"event_properties.custom"] = @"value";
return event;
}];

// Удалять, когда больше не требуется
[Astromkey removeEventModifier:subscriber];
</pre>

=== Ограничения модификаторов ===

Модификаторы событий имеют ограничения на то, какие поля могут быть изменены для обеспечения целостности данных.

'''Изменяемые поля'''

Следующие поля можно изменять или добавлять:

* <code>event_properties.*</code> — свойства события.
* <code>session_properties.*</code> — свойства сессии (только для событий, связанных со свойствами сессии).
* <code>url.full</code> — полный URL-адрес запроса.
* <code>exception.stack_trace</code> — трассировка стека исключений.

Все остальные поля доступны только для чтения и не могут быть изменены. Исходные значения сохраняются.

=== Важные соображения ===

* '''Потокобезопасность''' — модификаторы могут вызываться из любого потока; убедитесь, что ваш код потокобезопасен.
* '''Производительность''' — поддерживайте эффективность модификаторов; они применяются к каждому событию.

== Примеры модификаторов ==

=== Добавить контекст пользователя ко всем событиям ===

'''Swift'''
<pre>
class UserContext {
static var userId: String?
static var userTier: String?
}

func setupEventEnrichment() {
_ = Astromkey.addEventModifier { event in
if let userId = UserContext.userId {
event.fields["event_properties.user_id_hash"] = userId.hashValue
}
if let userTier = UserContext.userTier {
event.fields["event_properties.user_tier"] = userTier
}
return event
}
}
</pre>

'''Objective-C'''
<pre>
static NSString *userId = nil;
static NSString *userTier = nil;

- (void)setupEventEnrichment {
[Astromkey addEventModifier:^DTXModifyableEvent *(DTXModifyableEvent *event) {
if (userId) {
event.fields[@"event_properties.user_id_hash"] = @(userId.hash);
}
if (userTier) {
event.fields[@"event_properties.user_tier"] = userTier;
}
return event;
}];
}
</pre>

=== Добавить флаги функций ===

'''Swift'''
<pre>
func setupFeatureFlagTracking(featureFlags: [String: Bool]) {
_ = Astromkey.addEventModifier { event in
for (key, value) in featureFlags {
event.fields["event_properties.ff_\(key)"] = value
}
return event
}
}
</pre>

'''Objective-C'''
<pre>
- (void)setupFeatureFlagTrackingWithFlags:(NSDictionary<NSString *, NSNumber *> *)featureFlags {
[Astromkey addEventModifier:^DTXModifyableEvent *(DTXModifyableEvent *event) {
for (NSString *key in featureFlags) {
NSString *fieldKey = [NSString stringWithFormat:@"event_properties.ff_%@", key];
event.fields[fieldKey] = featureFlags[key];
}
return event;
}];
}
</pre>

=== Условное обогащение событий ===

'''Swift'''
<pre>
func setupConditionalEnrichment() {
_ = Astromkey.addEventModifier { event in
// Обогащать только HTTP-события
if event.fields["http.request.method"] != nil {
event.fields["event_properties.api_client"] = "ios_app"
event.fields["event_properties.api_version"] = "v2"
}

// Обогащать только события ошибок
if event.fields["exception.type"] != nil {
event.fields["event_properties.error_context"] = "user_session"
}

return event
}
}
</pre>

'''Objective-C'''
<pre>
- (void)setupConditionalEnrichment {
[Astromkey addEventModifier:^DTXModifyableEvent *(DTXModifyableEvent *event) {
// Обогащать только HTTP-события
if (event.fields[@"http.request.method"]) {
event.fields[@"event_properties.api_client"] = @"ios_app";
event.fields[@"event_properties.api_version"] = @"v2";
}

// Обогащать только события ошибок
if (event.fields[@"exception.type"]) {
event.fields[@"event_properties.error_context"] = @"user_session";
}

return event;
}];
}
</pre>

== Связанные темы ==

* Производительность веб-запросов — модификаторы HTTP-событий.
* Сообщения об ошибках и сбоях — события исключений.
* Конфигурация — конфигурация агента.

Пользовательские события для iOS - История изменений