Оформление
Справочник аудиторных кодов
Это общий машинный словарь Sales Ninja для аудиторных признаков. Он не принадлежит одному продукту: карта спроса, смарт-фид и другой потребитель ссылаются на одни и те же ключи и значения.
Главное
Ключи и коды чувствительны к регистру. Передавайте их буквально: ageBand, а не ageband; 18-24, а не 18_24; smartphone, а не mobile.
Эта страница перечисляет закрытые коды и форматы открытых аудиторных осей. Правила контейнерных словарей описаны в обзоре справочников, а полная трёхуровневая таксономия вынесена в справочник интересов.
Пол — gender
Для удобства российской аудитории значения пола и возрастные интервалы ниже повторяют привычную классификацию Яндекс.Метрики. В интеграции всё равно нужно использовать машинные коды Sales Ninja.
| Код | Значение | Пример условия |
|---|---|---|
male | Мужской | {"gender":"male"} |
female | Женский | {"gender":"female"} |
Неизвестный или не определённый пол не кодируется отдельным значением и не должен искусственно превращаться в male или female.
Возраст — ageBand
Интервалы не пересекаются: 24 года относится к 18-24, а 25 лет — к 25-34.
| Код | Возраст |
|---|---|
under18 | младше 18 лет |
18-24 | от 18 до 24 лет включительно |
25-34 | от 25 до 34 лет включительно |
35-44 | от 35 до 44 лет включительно |
45-54 | от 45 до 54 лет включительно |
55+ | 55 лет и старше |
Не передавайте точный возраст вместо диапазона. Значения 24, 55-64 или unknown не являются кодами ageBand.
Устройство — device
| Код | Значение | Типичный пример |
|---|---|---|
desktop | Компьютер или ноутбук | браузер на Windows, macOS или Linux |
smartphone | Смартфон | мобильный браузер на телефоне |
tablet | Планшет | браузер на планшете |
other | Остальной распознанный класс | телевизор или другое устройство вне трёх основных классов |
other — реальный класс, а не синоним отсутствующего значения. Если устройство не определено, условия по device нет.
Покупательная способность — purchasingPower
| Код | Значение |
|---|---|
high | Высокая прогнозная покупательная способность |
standard | Стандартная или не отнесённая к высокой |
Это категории модели, а не валюта, доход или точный бюджет человека. Значение high нельзя сравнивать между проектами как абсолютную денежную величину.
Эффективный тип соединения — connectionEffectiveType
| Код | Класс соединения |
|---|---|
slow-2g | очень медленное соединение класса 2G |
2g | 2G |
3g | 3G |
4g | 4G |
5g | 5G |
Это эффективная оценка клиентского окружения, а не тариф абонента. Плохой канал в современной сети может наблюдаться как более медленный класс.
Ориентация экрана — screenOrientation
| Код | Значение |
|---|---|
portrait | высота не меньше ширины |
landscape | ширина больше высоты |
Варианты окружения вроде portrait-primary нормализуются до одного из этих двух кодов.
День недели — dayOfWeek
| Код | День |
|---|---|
monday | понедельник |
tuesday | вторник |
wednesday | среда |
thursday | четверг |
friday | пятница |
saturday | суббота |
sunday | воскресенье |
День определяется по UTC-времени события. Не применяйте часовой пояс площадки повторно, если продуктовый контракт явно не требует локального времени.
Час UTC — utcHour
Полный закрытый набор — двухсимвольные строки от 00 до 23:
text
00 01 02 03 04 05 06 07 08 09 10 11
12 13 14 15 16 17 18 19 20 21 22 23"07" — корректно, "7" и число 7 — нет.
Браузер — browser
browser — открытая нормализованная строка в нижнем регистре. Примеры:
text
chrome
safari
firefox
edge
operaЭто не закрытый enum. Потребитель принимает новый корректный код и не отклоняет из-за него всю выгрузку.
Операционная система — operatingSystem
operatingSystem — открытая нормализованная строка в нижнем регистре. Примеры:
text
windows
android
ios
macos
linuxНе стройте валидацию на этом списке: семейства могут добавляться.
Основная версия ОС — operatingSystemMajorVersion
Значение — положительное целое число, записанное строкой, например "10", "17" или "14". Полная версия "17.5.1", префикс v17 и JSON-число 17 не входят в контракт.
Все аудиторные ключи
| Ключ | Режим | Пример или справочник |
|---|---|---|
country | контейнерный | dictionaries.countries |
region | контейнерный | dictionaries.regions |
city | контейнерный | dictionaries.cities |
device | закрытый | smartphone |
browser | открытый | chrome |
operatingSystem | открытый | android |
operatingSystemMajorVersion | открытая строка целого числа | 14 |
connectionEffectiveType | закрытый | 4g |
screenOrientation | закрытый | portrait |
gender | закрытый | female |
ageBand | закрытый | 25-34 |
purchasingPower | закрытый | high |
interest | контейнерный | дерево интересов |
dayOfWeek | закрытый | monday |
utcHour | закрытый | 07 |
Конкретный продукт может использовать только часть осей. Отсутствие оси в его контракте не удаляет её из общего справочника и не меняет её смысл.