Skip to main content

Объект userData

Вступление

userData – объект с пользовательскими данными. SDK и API Sigma целиком и полностью полагаются на предоставленные данные (методы по раздаче эксперимента, фича-флагов и т.п.).

При инициализации SDK следует предоставлять объект userData и передавать как можно больше данных, чтобы воспользоваться преимуществами расширенных условий и конфигурации (например, проверки на уровне страны или ОС/браузера).

Sigma не собирает данные, которые хранятся в объекте userData. Исключением является IP, которое необходимо для определения гео признаков.

Атрибуты пользователя

АтрибутыОписаниеКлючПример
User ID

ID анонимного пользователя. Используется для раздачи эксперимента и фича-флагов.

NodeJs < 3.0.0 и Js < 3.0.0: если userId не передан, Sigma сама создаст его, но в таком случае возможно переназначение варианта эксперимента

userIdyour_user_id
Profile IDID авторизованного пользователя (например, в личном кабинете)profileIdyour_profile_id
Device IDID устройства пользователя. Полезен для экспериментов, проводимых в приложении (Android и iOS)deviceIdyour_device_id
EmailEmail пользователяemailma@example.com
IPIP адрес пользователя.

Определяется автоматически.
Можно изменить, если указать в userData самому
ip192.168.1.101
CountryКод страны пользователя.

При использовании клиентского SDK будет назначено автоматически.
countryRussian Federation
LocaleКод страны(locale) пользователя.

При использовании клиентского SDK будет назначено автоматически
codeRU
CityГород пользователя.

При использовании клиентского SDK будет назначено автоматически
cityMoscow
StateОбласть/Штат пользователя.

При использовании клиентского SDK будет назначено автоматически
stateMoscowskaya oblast'
App Version

Версия приложения клиентского SDK(платформа android и ios).

Определяется автоматически.
Можно изменить, если указать в userData самому

appVersion1.0.1
Operating System

При использовании клиентского SDK будет назначена автоматически. В остальных случаях (NodeJs, API) необходимо указывать

os.nameAndroid
Operating System Version

При использовании клиентского SDK будет назначена автоматически. В остальных случаях (NodeJs, API) необходимо указывать

os.version9.4.1
Browser Name

При использовании клиентского SDK будет назначена автоматически. В остальных случаях (NodeJs, API) необходимо указывать

browser.nameChrome
Browser Verson

При использовании клиентского SDK будет назначена автоматически. В остальных случаях (NodeJs, API) необходимо указывать

browser.version45.0
Device Category

При использовании клиентского SDK (платформа web) будет назначен один из 3 вариантов mobile, tablet, desktop.
Можно изменить, если указать в userData самому.

deviceCategorymobile
Custom

Произвольный параметр пользователя.

Создается в интерфейсе Sigma. Поле, которое должно содержать пару ключ:значение. Ключ – наименование созданного параметра в интерфейса.

custom: {<YOUR_PARAMETER_KEY>: <YOUR_PARAMETER_VALUE>}custom: {customCookieId: 42}
Platform

Поле по которому можно отфильтровать конфиг (указано в админ панели). Например если передать platform: ios, эксперименты и фф с платформой web и android не будут считаться.



Только для SDK Node.js

platformplatform: [ "android", "web", "ios" ]
UA

Поле по которому SDK парсит user-agent. Значения: название, версию браузера и операционной системы автоматически запишет в browser и os.



Только SDK Node.js и Rest API

uaua: "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36"