Макросы Keitaro: справочник S2S постбеков и sub ID
Как словарь, макросы Keitaro приводят в действие каждый S2S постбек: настраиваемый вами URL - шаблон, и в момент отправки трекер подставляет плейсхолдеры - {external_id}, {conversion_revenue}, {status}, - наполненные реальными значениями конверсии. Осознанное использование превращает одну строку постбека в законченную самодокументируемую доставку; небрежное - рождает пустые параметры и несопоставленные конверсии. Справочник собирает документированные макросы по рабочим группам, плюс поля sub ID и правила кодировки, держащие всё целым. Полная процедура настройки - в гайде по настройке S2S; здесь всё начинается с таблиц.
Все строки ниже следуют документации плейсхолдеров Keitaro (плейсхолдеры S2S постбеков).
Идентификаторы
| Макрос | Значение |
|---|---|
{subid} | Субид |
{external_id} | Внешний ID, переданный источником трафика - переносчик click ID |
{tid} | Transaction ID |
{visitor_code} | Уникальный код посетителя |
На переносчике click ID стоит сделать главный акцент: пустой {external_id} в отправленном постбеке означает, что источник никогда не передавал свой параметр, и никакая настройка ниже клика не починит его.
Деньги: выручка, расход, профит
| Макрос | Значение |
|---|---|
{revenue} | Выручка конверсии |
{revenue:currency,percent} | Выручка в выбранной валюте с расчётом процента (доли), напр. {revenue:USD,70} |
{conversion_revenue} | Выручка, относящаяся к конверсии |
{conversion_cost} | Расход, отнесённый к конверсии |
{conversion_profit} | Профит конверсии, за вычетом расхода |
{profit} | Значение профита - выручка минус расход |
{cost} | Расход клика |
Денежные макросы принимают валютный параметр, конвертирующий из валюты трекера: {conversion_revenue:eur} отправит значение, сконвертированное в евро.
Статусы - и их переименование под адресата
| Макрос | Значение |
|---|---|
{status} | Статус конверсии |
{status:mapping} | Тот же статус, но с маппингом, напр. {status:lead=0 sale=1 rejected=2}; поддерживаются кастомные, вроде {status: lead=install sale=bill rejected=trash} |
Форма маппинга - способ кормить одним словарём трекера много адресатов: ваши записи хранят lead и sale, а адресат видит install или bill.
Таймстампы
| Макрос | Значение |
|---|---|
{date:format,timezone} | Дата клика - UTC по умолчанию, напр. {_date:Y-m-d H:i:s,Europe/Kyiv} (время самого клика) |
{conversion_time:format,timezone} | Дата и время конверсии, напр. {_conversion_time:Y-m-d H:i:s,Europe/Kyiv} (отдельно от даты клика) |
Кампании, офферы, источники
| Макрос | Значение |
|---|---|
{campaign_id} (алиас keitaro_campaign_id) | ID кампании |
{campaign_name} (алиас keitaro_campaign_name) | Имя кампании |
{campaign_alias} | Алиас кампании |
{ad_campaign_id} | Идентификатор рекламной кампании |
{creative_id} | Креатив - его идентификатор |
{landing_id} | Лендинг - его идентификатор |
{offer_id} | Оффер - его идентификатор |
{offer_name} | Имя оффера (работает с выбором Before click в мультиофферах) |
{offer_value:NAME} | Тянет параметр из дополнительных настроек Values оффера |
{stream_id} | ID потока |
{parent_campaign_id} | Предыдущая кампания через Send to campaign |
{ts_id} | ID источника трафика |
{traffic_source_name} | Имя источника трафика |
{affiliate_network_name} | Партнёрская сеть - её имя |
{sub_id_1} - {sub_id_30} | Тридцать параметров sub ID |
{source} | Сайт (раньше называлось source) |
Поля sub ID заслуживают собственной заметки: на входящей стороне постбека те же sub_id_1..sub_id_30 документированы как «дополнительные данные, обновляющие запись клика» (postback URL) - именно поэтому они естественный дом для меток офферов в трекинге ротации офферов.
Гео, устройство, сеть
| Макрос | Значение |
|---|---|
{country} (алиас country_code) | Код страны |
{country:lang} (алиас country_name) | Имя страны на заданном языке |
{region:lang} (алиас region_name) | Имя региона; пустой lang возвращает код региона |
{city} | Имя города |
{isp} | ISP |
{ip} | IP-адрес |
{browser} / {browser_version} | Браузер и его версия |
{os} / {os_version} | ОС и её версия |
{device_model} | Модель устройства |
{device_type:lang} | Тип устройства |
{language} | Код языка по ISO 639-1 |
{user_agent} (алиасы ua, useragent) | User agent браузера |
{connection_type:lang} | Тип подключения |
{is_bot} | Единица - для ботов |
{is_using_proxy} | Прокси - единица в значении |
Прочие плейсхолдеры
| Макрос | Значение |
|---|---|
{keyword:charset} | Ключевик с кодировкой, напр. {keyword:UTF-8} |
{search_engine} (алиас se) | Значение параметра se |
{referrer} (алиас referer) | Реферер |
{destination} | URL лендинга, URL оффера, URL редиректа потока или текст потока |
{current_domain} | Текущий домен кампании трекера |
{random:min,max} | Случайное число в диапазоне |
{sample:val1,val2,valN} | Одно значение наугад |
{from_file:file} | Грузит содержимое файла var/macros/file |
Правила использования: кодировка и валюты
Два документированных правила предотвращают большинство сломанных URL постбеков:
- Кодировка. Значения плейсхолдеров кодируются по умолчанию; префикс макроса с подчёркиванием - стиль
{_text}- даёт сырой вывод, когда адресату нужно неэкранированное значение. - Конвертация валют. Денежные макросы принимают валютный параметр, конвертирующий из валюты трекера:
{conversion_revenue:eur}.
Приёмочный тест остаётся тем же, что и везде в кластере: одна реальная конверсия через цепочку, затем S2S-лог (логи), показывающий каждый разрешённый в непустое значение плейсхолдер. Сигнатуры отказов и их фиксы - в гайде по настройке.
Макросы Keitaro: частые вопросы
Frequently asked questions
Источники
Sources
- Проверяйте каждый смаппленный URL: Pixel Activator бесплатно шлёт тестовые события в момент смены плейсхолдеров.
- Шаблоны честными держит: Most доставляет каждую конверсию с полным набором разрешённых плейсхолдеров.