Перечень и предназначение полей clickStream
Обновлено 20 декабря 2023
| Блок | № | Параметр | Тип | Описание поля | Обязательность | Доступность параметра в канале | Заполнение только при инициализации | Автоматический сбор параметра в JS | Автоматический сбор параметра в iOS | Автоматический сбор параметра в Android |
|---|---|---|---|---|---|---|---|---|---|---|
| meta | 1 | meta.apiKey | String | ID приложения (идентификатор для маршрутизации пакетов данных на бэкенд) | 1 | МП, WEB | + | - | - | - |
| 2 | meta.deviceVendor | String | Производитель устройства | 0-1 | МП, WEB | + | - | - | ||
| 3 | meta.deviceModel | String | Модель устройства | 0-1 | МП, WEB | + | - | - | ||
| 4 | meta.deviceMemorySize | String | Размер внутренней памяти устройства (в первую очередь актуально для iOS-устройств) | 0-1 | МП | + | - | + | - | |
| 5 | meta.operationSystem | String | Операционная система устройства | 0-1 для Мобильного Приложения данное поле обязательно | МП, WEB | + | + | + | - | |
| 6 | meta.operationSystemVersion | String | Версия операционной системы устройства | 0-1 | МП, WEB | + | + | - | ||
| 7 | meta.platform | String | Платформа (мобильное приложение, веб, планшет и прочее). Возможные значения: MOBILE WEB | 1 | МП, WEB | + | + | - | ||
| 8 | meta.systemLanguage | String | Язык в ОС | 1 | МП, WEB | + | + | - | ||
| 9 | meta.screenSize | String | Размер экрана | 0-1 | МП, WEB | + | + | - | ||
| 10 | meta.browser | String | Тип браузера | 0-1 | WEB | + | + | - | ||
| 11 | meta.sberId | String | сбер ID партнера | 0-1 | МП, WEB | + | - | - | ||
| 12 | meta.timeStamp | Date-Time | Время отправки пакета в формате ISO 8601 (YYYY-MM-DDThh:mm:ss.sss±hh:mm) | 1 | МП, WEB | + | + | - | ||
| profile | 13 | profile.deviceId | String | ID устройства (mGuid, стационарный идентификатор изменяется после переустановки приложения) Сначала IMEI. Если не смог - серийный номер. Если не смог - Мак Адрес. Если не смог - генерирует строку по времени. Из того что удалось получить - генерит уникальный ID. | 0-1 см.табл.2 | МП | - | - | - | |
| 14 | profile.sessionId | String | ID сессии | 0-1 | МП, WEB | - | - | - | ||
| 15 | profile.appId | String | Внутренний идентификатор клиента партнера. | 0-1 см.табл.2 | МП, WEB | - | - | - | - | |
| 16 | profile.partnerId | String | HASH телефона клиента (дополнительный идентификатор клиента партнера). | 0-1 см.табл.2 | МП, WEB | - | - | - | - | |
| 17 | profile.sapId | String | HASH e-mail'a клиента (дополнительный идентификатор клиента партнера). | 0-1 см.табл.2 | МП, WEB | - | - | - | - | |
| 18 | profile.subId | String | b2b Идентификатор клиента, который выдает единый сервис sberbank в процессе авторизации через SberbankID. | 0-1 см.табл.2 | МП, WEB | - | - | - | - | |
| 19 | profile.adId | String | Рекламный идентификатор (iOS - IDFA, Android - GAID) | 0-1 см.табл.2 | МП | - | - | + | - | |
| 20 | profile.appVersion | String | Версия приложения | 0-1 | МП | - | - | - | ||
| 21 | profile.applicationLanguage | String | Язык в приложении | 0-1 | МП | - | - | - | ||
| 22 | cookie[] | String | Массив кук, состоящий из объектов с параметрами key и value. | 0-1 см.табл.2 | WEB | - | + | - | ||
| 23 | utm[] | String | Массив utm меток, состоящий из объектов с параметрами key и value. | 0-1 | МП, WEB | + | + | - | ||
| data[] | 24 | data.eventCategory | String | Категория действия | 0-1 | МП, WEB | - | - | - | |
| 25 | data.eventAction | String | Название действия | 1 | МП, WEB | - | - | - | ||
| 26 | data.eventType | String | Тип пользовательского события ("TAP") | 0-1 | МП, WEB | - | - | - | ||
| 27 | data.value | String | Значение | 0-1 | МП, WEB | - | - | - | ||
| 28 | data.timeStamp | Date-Time | Время срабатывания события в формате ISO 8601 (YYYY-MM-DDThh:mm:ss.sss±hh:mm) | 1 | МП, WEB | - | + | - | ||
| 29 | data.geoLatitude | String | Широта геопозиции | 0-1 | МП, WEB | + | - | - | ||
| 30 | data.geoLongitude | String | Долгота геопозиции | 0-1 | МП, WEB | + | - | - | ||
| 31 | data.cellularProvider | String | Название оператора сотовой связи | 0-1 | МП | +/- | - | - | ||
| 32 | data.batteryLevel | String | Уровень заряда батареи | 0-1 | МП, WEB | - | + | - | ||
| 33 | data.connectionType | String | Тип связи (wifi/сотовая связь). Возможные значения: WIFI CELLULAR BLUETOOTH ETHERNET UNKNOWN | 0-1 | МП, WEB | - | + | - | ||
| 34 | data.internalIP | String | Внутренний IP | 0-1 | МП | +/- | - | - | ||
| 35 | data.properties[] | Array | Массив, состоящий из объектов с параметрами key и value. Это различные дополнительны параметры, необходимые для сформированного события. | 0-1 | МП, WEB | - | - | - |
Таблица 2: Требования к передаваемым данным для идентификации клиента:
| 1 | WEB | profile . cookie[] - См.строку - 22 | Обязательно один из параметров: profile . appId- См.строку -15 profile. subId- См.строку -18 + Обязательный параметр: profile . cookie[]- См.строку -22 +Желательные параметры: profile. sapId- См.строку -17 profile . partnerId- См.строку -16 |
| 2 | MOBILE | Один из параметров: profile. adId- См.строку -19 profile .deviceId- См.строку -13 | Обязательно один из параметров: profile . appId- См.строку -15 profile. subId- См.строку -18 + Обязательно один из параметров: profile. adId- См.строку - 19 profile .deviceId- См.строку -13 +Желательные параметры: profile. sapId- См.строку -17 profile . partnerId- См.строку -16 |