Admitad Teleport
Инструкция по настройке Teleport API
Admitad Teleport
Инструкция
по настройке Teleport API
по настройке Teleport API
Назначение
Установка
Геонастройки
Ошибки
A/B-тестирование
Поддержка
1 | НАЗНАЧЕНИЕ
С помощью инструмента вы можете исключить Admitad из цепочки редиректов от вашей площадки до рекламодателя. Это позволит избежать некорректных блокировок браузерами и расширениями, а также проще подготовиться к изменениям в политике приватности. Подробнее о преимуществах вы можете прочитать на главной странице инструмента Admitad Teleport.
Инструмент ориентирован на площадки, где партнёрская ссылка ad.admitad.com не указана в виде ссылки в контенте сайта, а присутствует в виде редиректа. Примерная схема работы инструмента:
Инструмент ориентирован на площадки, где партнёрская ссылка ad.admitad.com не указана в виде ссылки в контенте сайта, а присутствует в виде редиректа. Примерная схема работы инструмента:
2 | УСТАНОВКА
1
определите партнёрские ссылки Admitad, которые нужно преобразовать. Пример ссылки — https://ad.admitad.com/g/1e8d114494b7e165239416525dc3e8/;
Помимо ad.admitad.com, поддерживаются все трекинговые домены Admitad, кроме сокращателей ссылок (например, fas.st или ali.ski);
Помимо ad.admitad.com, поддерживаются все трекинговые домены Admitad, кроме сокращателей ссылок (например, fas.st или ali.ski);
2
замените часть ссылки ‘/g/ на ‘/tpt/’ — https://ad.admitad.com/tpt/1e8d114494b7e165239416525dc3e8/;
3
добавьте country_code для программ со специальными настройками для стран (см. раздел «Геонастройки») — https://ad.admitad.com/tpt/1e8d114494b7e165239416525dc3e8/?country_code=RU;
4
Добавьте user_agent пользователя (url encoded) и referrer страницы, на которой он находился перед кликом по этой ссылке
https://ad.admitad.com/tpt/1e8d114494b7e165239416525dc3e8/?ip_addr=0.0.0.0&user_agent=Chrome%2FMozilla%20Firefox&referer=https%3A%2F%2Fwww.google.com
UA нужен для того, чтобы Admitad мог отсекать ботовый трафик с ваших площадок, например, краулеры поисковых систем, в вашей статистике.
Referrer поможет команде Admitad в диагностике проблем c трекингом и в решении спорных ситуаций с рекламодателем.
https://ad.admitad.com/tpt/1e8d114494b7e165239416525dc3e8/?ip_addr=0.0.0.0&user_agent=Chrome%2FMozilla%20Firefox&referer=https%3A%2F%2Fwww.google.com
UA нужен для того, чтобы Admitad мог отсекать ботовый трафик с ваших площадок, например, краулеры поисковых систем, в вашей статистике.
Referrer поможет команде Admitad в диагностике проблем c трекингом и в решении спорных ситуаций с рекламодателем.
5
по необходимости добавьте ваши SubID к ссылке — https://ad.admitad.com/tpt/1e8d114494b7e165239416525dc3e8/?ip_addr=0.0.0.0&user_agent=Chrome%2FMozilla%20Firefox&referer=https%3A%2F%2Fwww.google.com&subid4=12345;
6
для замеров эффективности добавьте маркеры A/B-теста (см. раздел «A/B-тестирование») — https://ad.admitad.com/tpt/1e8d114494b7e165239416525dc3e8/?ip_addr=0.0.0.0&user_agent=Chrome%2FMozilla%20Firefox&referer=
https%3A%2F%2Fwww.google.com&subid4=12345&subid=tptA;
https%3A%2F%2Fwww.google.com&subid4=12345&subid=tptA;
7
вместо редиректа по этой ссылке проведите запрос с вашего сервера — Admitad ответит JSON-массивом со ссылкой на рекламодателя:
[
"redirect_url"
]
Вместо redirect_url вам придёт ссылка вида https://www.advertiser.com?admitad_uid=b8b3fba19a9d6788408610c627f5045e&utm_source=admitad&utm_medium=affiliate. Извлеките эту ссылку из массива и проведите по ней пользователя.
[
"redirect_url"
]
Вместо redirect_url вам придёт ссылка вида https://www.advertiser.com?admitad_uid=b8b3fba19a9d6788408610c627f5045e&utm_source=admitad&utm_medium=affiliate. Извлеките эту ссылку из массива и проведите по ней пользователя.
3 | ГЕОНАСТРОЙКИ
В Admitad есть программы, в которых от страны пользователя зависит вознаграждение веб-мастера или финальный URL рекламодателя.
Поскольку запрос на Admitad по Teleport API будет поступать с сервера веб-мастера, определить страну силами Admitad у таких программ не удастся вам необходимо передать IP-адрес пользователя в Admitad:
Поскольку запрос на Admitad по Teleport API будет поступать с сервера веб-мастера, определить страну силами Admitad у таких программ не удастся вам необходимо передать IP-адрес пользователя в Admitad:
Если пользователь запретил в настройках своей приватности передачу его IP-адреса, то определите страну пользователя, используя геосервисы наподобие MaxMind и передайте двухбуквенный country_code в стандарте ISO 3166-1 alpha-2 в запросе Admitad:
https://ad.admitad.com/tpt/1e8d114494b7e165239416525dc3e8/?country_code=RU
Такие IP-адрес/country_code будут иметь приоритет над IP-адресом отправителя запроса и позволит верно определить вознаграждение за заказ. Желательно передавать IP-адрес/country_code по всем программам. Если вы не можете определять IP-адрес или страну пользователя, используйте в Teleport API только программы без геонастроек (см. раздел «Ошибки»).
4 | ОШИБКИ
Dummy
Геонастройки
Неподдерживаемая программа
Dummy
Если площадка не подключена к партнёрской программе, в ответе поступит адрес страницы-заглушки dummy:
["https://ad.admitad.com/dummy/?w=1165099&c=15855&r=3&d=3"]
Рекомендуем пускать пользователя по ссылке dummy, но реагировать на появление таких переходов через отчёт «Битые ссылки» (доступно также через API) — перенаправьте трафик на программы, к которым площадка подключена.
["https://ad.admitad.com/dummy/?w=1165099&c=15855&r=3&d=3"]
Рекомендуем пускать пользователя по ссылке dummy, но реагировать на появление таких переходов через отчёт «Битые ссылки» (доступно также через API) — перенаправьте трафик на программы, к которым площадка подключена.
Геонастройки
Если у партнерской программы есть индивидуальные геонастройки, при попытке запроса по ней без IP-адреса/country_code придёт ответ 400 и сообщение {"error": "country_code or ip_addr is mandatory"} — добавьте GET-параметр ip_addr/country_code с IP-адресом или двухбуквенным значением страны к запросу и повторите его. Если вы не можете добавить IP-адрес/country_code, используйте последовательный редирект на стандартный адрес (замените ‘/tpt/’ обратно на ‘/g/’ — https://ad.admitad.com/g/1e8d114494b7e165239416525dc3e8/).
Неподдерживаемая программа
Существуют программы, которые временно не могут поддерживать API-решение. Список программ динамический (программа временно может появляться и пропадать из списка поддерживаемых).
При попытке запроса по этим программам вы получите ответ 403 и сообщение:
{"error": "teleport API response is currently not being supported for affiliate program id {campaign_id}"}
Вместо {campaign_id} будет указан ID партнёрской программы. Если ошибка возникает, залогируйте её и направьте пользователя по обычной партнёрской ссылке (замените ‘/tpt/’ обратно на ‘/g/ — https://ad.admitad.com/g/1e8d114494b7e165239416525dc3e8/). Через некоторое время программа может снова стать поддерживаемой — рекомендуем повторять попытку раз в 2-4 недели, так как программы активно дорабатываются под работу с Teleport API.
При попытке запроса по этим программам вы получите ответ 403 и сообщение:
{"error": "teleport API response is currently not being supported for affiliate program id {campaign_id}"}
Вместо {campaign_id} будет указан ID партнёрской программы. Если ошибка возникает, залогируйте её и направьте пользователя по обычной партнёрской ссылке (замените ‘/tpt/’ обратно на ‘/g/ — https://ad.admitad.com/g/1e8d114494b7e165239416525dc3e8/). Через некоторое время программа может снова стать поддерживаемой — рекомендуем повторять попытку раз в 2-4 недели, так как программы активно дорабатываются под работу с Teleport API.
5 | A/B-ТЕСТИРОВАНИЕ
Если вы хотите измерить эффективность Teleport API, проведите A/B-тест: настройте переключение трафика при каждом клике либо на вариант A (Teleport API), либо на вариант B (старый, последовательный редирект) — сплит 50% на 50%:
При варианте А совершите серверный запрос по Teleport API
и добавьте параметр subid=tptA:
https://ad.admitad.com/tpt/1e8d114494b7e165239416525dc3e8/?country_code=RU&subid=tptA
Далее извлеките JSON-ответ и проведите 302 редирект по правилам Teleport API (см. раздел «Установка»).
Мы рекомендуем использовать именно параметр SubID, так как по нему настроена фильтрация в большинстве разделов статистики. Если параметр SubID занят, можно использовать параметры SubID1–SubID4, но фильтрация по ним доступна только в отчёте «По SubID», а также при выгрузке полной статистики в XLS или через API для веб-мастеров
и добавьте параметр subid=tptA:
https://ad.admitad.com/tpt/1e8d114494b7e165239416525dc3e8/?country_code=RU&subid=tptA
Далее извлеките JSON-ответ и проведите 302 редирект по правилам Teleport API (см. раздел «Установка»).
Мы рекомендуем использовать именно параметр SubID, так как по нему настроена фильтрация в большинстве разделов статистики. Если параметр SubID занят, можно использовать параметры SubID1–SubID4, но фильтрация по ним доступна только в отчёте «По SubID», а также при выгрузке полной статистики в XLS или через API для веб-мастеров
При варианте В сразу проведите 302 редирект на партнёрскую сеть, но добавьте в партнёрскую ссылку параметр subid=tptB:
https://ad.admitad.com/g/1e8d114494b7e16
5239416525dc3e8/?subid=tptB.
https://ad.admitad.com/g/1e8d114494b7e16
5239416525dc3e8/?subid=tptB.
6 | ПОДДЕРЖКА
При возникновении вопросов по работе инструмента создайте тикет в службу поддержки или обратитесь к вашему персональному менеджеру.
