Передача свойств
Убедитесь, что предыдущие шаги выполнены успешно
- SDK добавлено в ваше мобильное приложение
- Ключи взяты из раздела для разработчика: Ключи для SDK
- Инициализация выполнена успешно
Результат шага
- Свойства пользователя корректно передаются в карточку пользователя
Пользовательские свойства
Чтобы установить пользовательское свойство, используйте метод:
await Carrot.setUserProperty(userProperty);Для описания свойства используется класс UserProperty:
final userProperty = UserProperty('custom_key', 'custom_value');key не может начинаться с символа $.
Системные свойства пользователя
Все названия свойств, начинающиеся с символа $, считаются системными. Ваши собственные свойства не должны начинаться с $.
Разрешено изменять только 3 свойства: $name, $phone, $email. Все остальные системные свойства можно только читать.
| Имя | Описание |
|---|---|
$name | Имя |
$email | |
$phone | Телефон |
$last_seen | Последняя активность, дата совершения последнего события |
$last_contacted | Последний контакт, дата последнего ответа от пользователя или последней отправки сообщения пользователю (в том числе автосообщения) |
$last_reply | Дата последнего ответа от пользователя |
$conversations_emails | Количество диалогов по email |
$conversations_chats | Количество диалогов с типом чат |
$conversations_popups | Количество диалогов с типом поп-ап |
$sessions | Количество сессий |
$user_id | User ID |
$score | Количество баллов (рейтинг) |
$initial_referrer | Первый источник (реферрер) |
$initial_referrer_domain | Первый источник (реферрер), но только домен |
$initial_utm_campaign | Первая метка UTM Campaign |
$initial_utm_source | Первая метка UTM Source |
$initial_utm_medium | Первая метка UTM Medium |
$initial_utm_content | Первая метка UTM Content |
$initial_utm_term | Первая метка UTM Term |
$last_utm_campaign | Последняя метка UTM Campaign |
$last_utm_source | Последняя метка UTM Source |
$last_utm_medium | Последняя метка UTM Medium |
$last_utm_content | Последняя метка UTM Content |
$last_utm_term | Последняя метка UTM Term |
$country | Страна |
$region | Регион |
$city | Город |
$latitude | Географическая широта |
$longitude | Географическая долгота |
$email_unsubscribed | Отписался от email |
$avatar | Имя файла с аватаром. Аватарки пользователей лежат по адресу: https://files.carrotquest.io/avatars-users/ |
$social_vk | URL страницы ВКонтакте |
$social_facebook | URL страницы Facebook |
$social_fourqsuare | URL страницы Foursquare |
$social_googleplus | URL страницы Google+ |
$social_pinterest | URL страницы Pinterest |
$social_twitter | URL страницы Twitter |
$social_skype | Skype |
Устаревшие deprecated свойства: $comment, $last_active_user, $online, $idle, $cluster_id, $app_uid, $uid, $identity.
После первого совершения события у пользователя появляются три свойства, связанные с этим событием. Например, если событие имеет ID=123, появятся свойства:
| Имя | Описание |
|---|---|
$event_123_count | Сколько раз было совершено событие |
$event_123_first | Дата, когда событие было совершено первый раз |
$event_123_last | Дата, когда событие было совершено последний раз |
Свойства для интернет-магазинов
Свойства, специфичные для интернет-магазинов. Эти свойства можно записывать через API.
| Имя | Описание |
|---|---|
$cart_amount | Сумма в корзине (целое число) |
$viewed_products | Просмотренные товары (список из названий товаров) |
$cart_items | Корзина (список из названий товаров) |
$last_order_status | Статус последнего заказа |
$last_payment | Сумма последнего заказа (целое число) |
$revenue | Сумма всех заказов (целое число) |
$profit | Доход с пользователя (целое число) |
$group | Группа |
$discount | Скидка (целое число) |
$orders_count | Количество заказов (целое число) |
$ordered_items | Заказанные товары (список из названий товаров) |
$ordered_categories | Категории заказанных товаров (список из названий категорий товаров) |
$viewed_categories | Категории просмотренных товаров (список из названий категорий товаров) |
Классы для системных свойств
Для системных свойств в SDK предусмотрены классы:
CarrotUserProperty— основные системные свойства ($name,$phone,$email)EcommerceUserProperty— свойства для интернет-магазинов
Они позволяют передавать системные и e-commerce свойства в формате, поддерживаемом Carrot quest.
Пример передачи свойства
final userProperty = UserProperty('subscription_plan', 'premium');
await Carrot.setUserProperty(userProperty);