Download clickworker: Difference between revisions
(Marked this version for translation) |
No edit summary |
||
| Line 2: | Line 2: | ||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
To verify click-through links, we use a ''clickworker'', a special page on our domain. | |||
<!--T:2--> | <!--T:2--> | ||
If you want to avoid losses and delays in cross-domain redirects, you can download the clickworker and host it on your server. It needs to be updated once a day because we regularly make changes to the scripts. | |||
<!--T:3--> | <!--T:3--> | ||
''' | '''Please note that this option is only available for ''Redirect''-type integrations.''' | ||
<!--T:4--> | <!--T:4--> | ||
= | = Option Activation = | ||
Request the activation of the '''Download Clickworker''' option from your manager for your integration. Once enabled, a download link will appear in the integration for you to retrieve the clickworker. | |||
<!--T:5--> | <!--T:5--> | ||
| Line 18: | Line 18: | ||
<!--T:6--> | <!--T:6--> | ||
= | = Templates = | ||
The curly brackets in the link contain templates, and they will be passed into the code as they are. | |||
<!--T:7--> | <!--T:7--> | ||
| Line 28: | Line 28: | ||
<!--T:9--> | <!--T:9--> | ||
When delivering the clickworker to the user, you can dynamically replace the templates with current data. | |||
<!--T:10--> | <!--T:10--> | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! | ! Name !! Description | ||
|- | |- | ||
| kmnrId || kmnrId, | | kmnrId || kmnrId, generated during the ping at {{KamiLink|v2/ping}}. Needed for linking clicks if the '''[[S2S ping]]''' option is enabled. | ||
|- | |- | ||
| kmnrKey || | | kmnrKey || Integration identifier under which the impression is analyzed. | ||
|- | |- | ||
| sub1 || | | sub1 || Filled sub-tags. If you are not using certain tags, it is not mandatory to send them. | ||
|- | |- | ||
| sub2 || ... | | sub2 || ... | ||
| Line 59: | Line 59: | ||
| sub10 || ... | | sub10 || ... | ||
|- | |- | ||
| u || | | u || The target link to which the user will be directed after verification. It should be in a URL-safe format (for example, processed with the JavaScript method [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent encodeURIComponent]). | ||
|} | |} | ||
<!--T:11--> | <!--T:11--> | ||
If you are not using kmnrId, or you do not need all sub-tags, or if you have [[Traffic back URL|Traffic-back URL]] instead of clickUrl, simply remove unnecessary templates from the link. | |||
<!--T:12--> | <!--T:12--> | ||
| Line 70: | Line 70: | ||
<!--T:13--> | <!--T:13--> | ||
= Headers = | = Headers = | ||
For the clickworker to function correctly, it must send the following headers to the user's browser: | |||
<pre> | <pre> | ||
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 | 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 | ||
Revision as of 13:54, 30 November 2023
To verify click-through links, we use a clickworker, a special page on our domain.
If you want to avoid losses and delays in cross-domain redirects, you can download the clickworker and host it on your server. It needs to be updated once a day because we regularly make changes to the scripts.
Please note that this option is only available for Redirect-type integrations.
Option Activation
Request the activation of the Download Clickworker option from your manager for your integration. Once enabled, a download link will appear in the integration for you to retrieve the clickworker.
Templates
The curly brackets in the link contain templates, and they will be passed into the code as they are.
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
When delivering the clickworker to the user, you can dynamically replace the templates with current data.
| Name | Description |
|---|---|
| kmnrId | kmnrId, generated during the ping at https://kaminari.systems/v2/ping. Needed for linking clicks if the S2S ping option is enabled. |
| kmnrKey | Integration identifier under which the impression is analyzed. |
| sub1 | Filled sub-tags. If you are not using certain tags, it is not mandatory to send them. |
| sub2 | ... |
| sub3 | ... |
| sub4 | ... |
| sub5 | ... |
| sub6 | ... |
| sub7 | ... |
| sub8 | ... |
| sub9 | ... |
| sub10 | ... |
| u | The target link to which the user will be directed after verification. It should be in a URL-safe format (for example, processed with the JavaScript method encodeURIComponent). |
If you are not using kmnrId, or you do not need all sub-tags, or if you have Traffic-back URL instead of clickUrl, simply remove unnecessary templates from the link.
https://kaminari.space/v1/click?kmnrKey=767073697&sub1={sub1}&sub2={sub2}&u={clickUrl}&download
Headers
For the clickworker to function correctly, it must send the following headers to the user's browser:
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: *