Revision as of 17:18, 19 April 2024

Other languages:

English
русский

По умолчанию для проверки кликовых ссылок на интеграции с типом Meta Redirect мы используем кликворкер, специальную страницу на домене Kaminari Click, которая проверяет пользователя на фродовость и затем редиректит его на целевую ссылку или в трафик-бек, если включена соответствующая опция. Такой подход максимально прост и удобен, но имеет ряд нюансов.

Если вдруг у нас на сервере случится техническая проблема, и редирект поломается, трафик будет потерян.
Редиректы с одного сайта на другой проходят медленнее, чем внутри одного сайта, поэтому редирект через наш кликворкер может увеличивать процент недоходов до целевой ссылки.
Вы можете чувствовать дискомфорт от того, что в цепочку редиректов включается третья сторона.

Для решения этих проблем мы предлагаем скачивать кликворкер себе и размещать его на своём сервере. Необходимо обновлять его раз в сутки, потому что мы постоянно вносим изменения в скрипты.

Обратите внимание, опция доступна только в интеграциях типа Redirect.

Подключение опции

Закажите у менеджера включение опции Download clickworker на своей интеграции. После того как её включат, в интеграции появится ссылка для скачивания.

Шаблоны

В фигурных скобках в ссылке находятся шаблоны, они будут как есть прокинуты в код.

https://kaminari.space/v1/click?kmnrKey=XXXXXXXXX&kmnrId={kmnrId}&sub1={sub1}&sub2={sub2}&sub3={sub3}&sub4={sub4}&sub5={sub5}&sub6={sub6}&sub7={sub7}&u={clickUrl}&download

При отдаче кликворкера пользователю вы можете на лету заменять шаблоны актуальными данными.

Описание шаблонов

Название	Описание	Примечания
kmnrId	kmnrId, сгенерированный при отстуке на https://kaminari.systems/v2/ping. Нужен для склеивания кликов если у вас подключена опция S2S ping.	Обязателен, если включена опция S2S ping
kmnrKey	Идентификатор интеграции, в рамках которой анализируется показ.	Обязательный параметр
sub1	Заполенные суб-метки. Если какие-то метки вы не используете, их слать не обязательно.	-
sub2	...	-
sub3	...	-
sub4	...	-
sub5	...	-
sub6	...	-
sub7	...	-
sub8	...	Доступен, если включена опция Additional subs
sub9	...	Доступен, если включена опция Additional subs
sub10	...	Доступен, если включена опция Additional subs
u	целевая ссылка, на которую пользователь будет отправлен после проверки. Должна быть в URL-безопасном виде (например, обработана JS-методом encodeURIComponent).	Обязательный параметр в случае, если включена опция Target URL

https://kaminari.space/v1/click?kmnrKey=767073697&sub1={sub1}&sub2={sub2}&u={clickUrl}&download

Headers

Для корректной работы кликворкер должен отдавать браузеру пользователя следующие заголовки:

access-control-allow-origin: *
access-control-allow-methods: GET, POST, OPTIONS
access-control-allow-headers: X-Requested-With, Cache-Control, Content-Type
accept-ch: Width, Viewport-Width, DPR, Device-Memory, Downlink, RTT, ECT, Save-Data, Sec-CH-UA-Arch, Sec-CH-UA-Bitness, Sec-CH-UA-Mobile, Sec-CH-UA-Model, Sec-CH-UA-Platform, Sec-CH-UA-Platform-Version, Sec-CH-UA, Sec-CH-UA-Full-Version

Пример реализации

Ниже находится пример простейшей реализации кликворкера на вашей стороне с помощью PHP.

Допустим вы владелец сайта my-site.com и к вам проходят по ссылкам типа такой

https://my-site.com/click.php?utm_source=1&utm_campaign=123&utm_click_id=93652664834&target=https%3A%2F%2Fgoogle.com

Вы хотите, чтобы мы проверяли пользователя на фрод и редиректили на целевую ссылку (в данном случае google).

Создание ссылки

Вы решили, чтобы будете брать данные прямо из GET-параметров и utm_source будет писаться в sub1, utm_campaign — в sub2 и utm_click_id — в sub3.

Далее вам надо скопировать ссылку для скачивания кликворкера и заменить нужные вам шаблоны {sub1}, {sub2}, {sub3}, {clickUrl}. Остальные можно удалить.

В итоге у вам получится такая ссылка:

https://kaminari.space/v1/click?kmnrKey=XXXXXXXXX&sub1=<?=$_GET['utm_source']?>&sub2=<?=$_GET['utm_campaign']?>&sub3=<?=$_GET['utm_source_id']?>&u=<?=$_GET['target']?>&download

Скачивание кликворкера

Скачайте по получившийся ссылке кликворкер и сохраните его в файл clickworker.php.

Затем вам надо создать файл click.php, поместить в него заголовки и вызов clickworker.php.

<?php

    header('Access-Control-Allow-Origin: *');
    header('access-control-allow-methods: GET, POST, OPTIONS');
    header('access-control-allow-headers: X-Requested-With, Cache-Control, Content-Type');
    header('accept-ch: Width, Viewport-Width, DPR, Device-Memory, Downlink, RTT, ECT, Save-Data, Sec-CH-UA-Arch, Sec-CH-UA-Bitness, Sec-CH-UA-Mobile, Sec-CH-UA-Model, Sec-CH-UA-Platform, Sec-CH-UA-Platform-Version, Sec-CH-UA, Sec-CH-UA-Full-Version');
    
    include_once('clickworker.php');

Файлы надо разместить на сайте.

Проверка

Для проверки зайтите в браузере по ссылке

https://my-site.com/click.php?utm_source=1&utm_campaign=123&utm_click_id=93652664834&target=https%3A%2F%2Fgoogle.com

Прекрасно, редирект сработал и вы оказались на сайте Гугла.

Время проверить статистику. Отлично. Клик был зачитан, метки были прокинуты верно.

@@ Line 1: / Line 1: @@
 <languages/>
-Для проверки кликовых ссылок мы используем ''кликворкер'', специальную страницу на своём домене.
+По умолчанию для проверки кликовых ссылок на интеграции с типом [[Meta redirect|Meta Redirect]] мы используем ''кликворкер'', специальную страницу на домене Kaminari Click, которая проверяет пользователя на фродовость и затем редиректит его на целевую ссылку или в [[Traffic back URL|трафик-бек]], если включена соответствующая опция. Такой подход максимально прост и удобен, но имеет ряд нюансов.
-Если вы хотите избежать потерь и задержек на кроссдоменных редиректах, вы может скачать кликворкер себе и разместить на своём сервере. Необходимо обновлять его раз в сутки, потому что мы постоянно вносим изменения в скрипты.
+# Если вдруг у нас на сервере случится техническая проблема, и редирект поломается, трафик будет потерян.
+# Редиректы с одного сайта на другой проходят медленнее, чем внутри одного сайта, поэтому редирект через наш кликворкер может увеличивать процент недоходов до целевой ссылки.
+# Вы можете чувствовать дискомфорт от того, что в цепочку редиректов включается третья сторона.
+Для решения этих проблем мы предлагаем скачивать ''кликворкер'' себе и размещать его на своём сервере. Необходимо обновлять его '''раз в сутки''', потому что мы постоянно вносим изменения в скрипты.
 '''Обратите внимание, опция доступна только в интеграциях типа ''Redirect''.'''
@@ Line 17: / Line 21: @@
 [[File:Download clickworker2.png]]
+<br />
+<br />
 При отдаче кликворкера пользователю вы можете на лету заменять шаблоны актуальными данными.
+== Описание шаблонов ==
 {| class="wikitable"
 |-
-! Название !! Описание
+! Название !! Описание !! Примечания
 |-
-| kmnrId || kmnrId, сгенерированный при отстуке на {{KamiLink|v2/ping}}. Нужен для склеивания кликов если у вас подключена опция '''[[S2S ping]]'''.
+| kmnrId || kmnrId, сгенерированный при отстуке на {{KamiLink|v2/ping}}. Нужен для склеивания кликов если у вас подключена опция '''[[S2S ping]]'''. || Обязателен, если включена опция [[S2S ping]]
 |-
-| kmnrKey || Идентификатор интеграции, в рамках которой анализируется показ.
+| kmnrKey || Идентификатор интеграции, в рамках которой анализируется показ. || Обязательный параметр
 |-
-| sub1 || Заполенные суб-метки. Если какие-то метки вы не используете, их слать не обязательно.
+| sub1 || Заполенные суб-метки. Если какие-то метки вы не используете, их слать не обязательно. || -
 |-
-| sub2 || ...
+| sub2 || ... || -
 |-
-| sub3 || ...
+| sub3 || ... || -
 |-
-| sub4 || ...
+| sub4 || ... || -
 |-
-| sub5 || ...
+| sub5 || ... || -
 |-
-| sub6 || ...
+| sub6 || ... || -
 |-
-| sub7 || ...
+| sub7 || ... || -
 |-
-| sub8 || ...
+| sub8 || ... || Доступен, если включена опция [[Additional subs]]
 |-
-| sub9 || ...
+| sub9 || ... || Доступен, если включена опция [[Additional subs]]
 |-
-| sub10 || ...
+| sub10 || ... || Доступен, если включена опция [[Additional subs]]
 |-
-| u || целевая ссылка, на которую пользователь будет отправлен после проверки. Должна быть в URL-безопасном виде (например, обработана JS-методом [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent encodeURIComponent]).
+| u || целевая ссылка, на которую пользователь будет отправлен после проверки. Должна быть в URL-безопасном виде (например, обработана JS-методом [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent encodeURIComponent]). || Обязательный параметр в случае, если включена опция [[Target URL|Target URL]]
 |}
-Если вы не используете kmnrId, или вам не нужны все sub-метки, или вместо clickUrl у вас подключён [[Traffic back URL|Traffic-back URL]], просто удалите ненужные шаблоны из ссылки.
 <pre>https://kaminari.space/v1/click?kmnrKey=767073697&sub1={sub1}&sub2={sub2}&u={clickUrl}&download</pre>
@@ Line 58: / Line 63: @@
 Для корректной работы кликворкер должен отдавать браузеру пользователя следующие заголовки:
 <pre>
+access-control-allow-origin: *
+access-control-allow-methods: GET, POST, OPTIONS
+access-control-allow-headers: X-Requested-With, Cache-Control, Content-Type
 accept-ch: Width, Viewport-Width, DPR, Device-Memory, Downlink, RTT, ECT, Save-Data, Sec-CH-UA-Arch, Sec-CH-UA-Bitness, Sec-CH-UA-Mobile, Sec-CH-UA-Model, Sec-CH-UA-Platform, Sec-CH-UA-Platform-Version, Sec-CH-UA, Sec-CH-UA-Full-Version
-access-control-allow-headers: X-Requested-With, Cache-Control, Content-Type
-access-control-allow-methods: GET, POST, OPTIONS
-access-control-allow-origin: *
 </pre>
+<span id="Example_implementation"></span>
+= Пример реализации =
+Ниже находится пример простейшей реализации кликворкера на вашей стороне с помощью PHP.
+Допустим вы владелец сайта '''my-site.com''' и к вам проходят по ссылкам типа такой
+<pre>https://my-site.com/click.php?utm_source=1&utm_campaign=123&utm_click_id=93652664834&target=https%3A%2F%2Fgoogle.com</pre>
+Вы хотите, чтобы мы проверяли пользователя на фрод и редиректили на целевую ссылку (в данном случае google).
+== Создание ссылки ==
+Вы решили, чтобы будете брать данные прямо из GET-параметров и ''utm_source'' будет писаться в '''sub1''', ''utm_campaign'' — в '''sub2''' и ''utm_click_id'' — в '''sub3'''.
+Далее вам надо скопировать ссылку для скачивания кликворкера и заменить нужные вам шаблоны {sub1}, {sub2}, {sub3}, {clickUrl}. Остальные можно удалить.
+[[File:Clickworker-link.png]]
+В итоге у вам получится такая ссылка:
+<pre>https://kaminari.space/v1/click?kmnrKey=XXXXXXXXX&sub1=<?=$_GET['utm_source']?>&sub2=<?=$_GET['utm_campaign']?>&sub3=<?=$_GET['utm_source_id']?>&u=<?=$_GET['target']?>&download</pre>
+== Скачивание кликворкера ==
+Скачайте по получившийся ссылке кликворкер и сохраните его в файл '''clickworker.php'''.
+[[File:Clickworker-page2.png]]
+Затем вам надо создать файл '''click.php''', поместить в него заголовки и вызов '''clickworker.php'''.
+<pre>
+<?php
+    header('Access-Control-Allow-Origin: *');
+    header('access-control-allow-methods: GET, POST, OPTIONS');
+    header('access-control-allow-headers: X-Requested-With, Cache-Control, Content-Type');
+    header('accept-ch: Width, Viewport-Width, DPR, Device-Memory, Downlink, RTT, ECT, Save-Data, Sec-CH-UA-Arch, Sec-CH-UA-Bitness, Sec-CH-UA-Mobile, Sec-CH-UA-Model, Sec-CH-UA-Platform, Sec-CH-UA-Platform-Version, Sec-CH-UA, Sec-CH-UA-Full-Version');
+    include_once('clickworker.php');
+</pre>
+Файлы надо разместить на сайте.
+<span id="Testing"></span>
+== Проверка ==
+Для проверки зайтите в браузере по ссылке
+<pre>https://my-site.com/click.php?utm_source=1&utm_campaign=123&utm_click_id=93652664834&target=https%3A%2F%2Fgoogle.com</pre>
+Прекрасно, редирект сработал и вы оказались на сайте Гугла.
+[[File:Clickworker-redirect2.png]]
+<br />
+<br />
+Время проверить статистику.
+Отлично. Клик был зачитан, метки были прокинуты верно.
+[[File:Clickworker-stat.png]]
 [[Category:Features]]