Download clickworker: Difference between revisions
No edit summary |
No edit summary |
||
Line 2: | Line 2: | ||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
By default, to verify click-through links for Meta Redirect-type integrations, we use a ''clickworker'', a special page on the Kaminari Click domain, which checks the user and then redirects good users to the target link, and bots to [[Traffic back URL|traffic-back URL]], if the corresponding option is enabled. This approach is as simple and convenient as possible, but has a number of disadvantages. | |||
# If suddenly a technical problem occurs on our server, the redirect breaks down and your traffic will be lost. | |||
# Redirects between different sites are slower than within one site, so a redirect through our clickworker can increase the percentage of non-revenue to the target link. | |||
# You may feel uncomfortable that a third party is included in the redirect chain. | |||
<!--T:2--> | <!--T:2--> | ||
To solve these problems, we suggest downloading the ''clickworker'' and hosting 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.''' | '''Please note that this option is only available for ''Meta Redirect''-type integrations.''' | ||
<!--T:4--> | <!--T:4--> | ||
Line 30: | Line 34: | ||
When delivering the clickworker to the user, you can dynamically replace the templates with current data. | When delivering the clickworker to the user, you can dynamically replace the templates with current data. | ||
== Templates description == | |||
<!--T:10--> | <!--T:10--> | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! Name !! Description | ! Name !! Description !! Note | ||
|- | |- | ||
| kmnrId || kmnrId, generated during the ping at {{KamiLink|v2/ping}}. Needed for linking clicks if the '''[[S2S ping]]''' option is enabled. | | kmnrId || kmnrId, generated during the ping at {{KamiLink|v2/ping}}. Needed for linking clicks if the '''[[S2S ping]]''' option is enabled. || - | ||
|- | |- | ||
| kmnrKey || Integration identifier under which the impression is analyzed. | | kmnrKey || Integration identifier under which the impression is analyzed. || Required parameter | ||
|- | |- | ||
| sub1 || Filled sub-tags. If you are not using certain tags, it is not mandatory to send them. | | sub1 || Filled sub-tags. If you are not using certain tags, it is not mandatory to send them. || - | ||
|- | |- | ||
| sub2 || ... | | sub2 || ... || - | ||
|- | |- | ||
| sub3 || ... | | sub3 || ... || - | ||
|- | |- | ||
| sub4 || ... | | sub4 || ... || - | ||
|- | |- | ||
| sub5 || ... | | sub5 || ... || - | ||
|- | |- | ||
| sub6 || ... | | sub6 || ... || - | ||
|- | |- | ||
| sub7 || ... | | sub7 || ... || - | ||
|- | |- | ||
| sub8 || | | sub8 || Available if the option [[Additional subs|Additional subs]] is enabled || - | ||
|- | |- | ||
| sub9 || | | sub9 || Available if the option [[Additional subs|Additional subs]] is enabled || - | ||
|- | |- | ||
| sub10 || | | sub10 || Available if the option [[Additional subs|Additional subs]] is enabled || - | ||
|- | |- | ||
| 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]). | | 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]). || Required parameter if the option [[Target URL|Target URL]] is not enabled | ||
|} | |} | ||
<!--T:12--> | <!--T:12--> |
Revision as of 15:39, 19 April 2024
By default, to verify click-through links for Meta Redirect-type integrations, we use a clickworker, a special page on the Kaminari Click domain, which checks the user and then redirects good users to the target link, and bots to traffic-back URL, if the corresponding option is enabled. This approach is as simple and convenient as possible, but has a number of disadvantages.
- If suddenly a technical problem occurs on our server, the redirect breaks down and your traffic will be lost.
- Redirects between different sites are slower than within one site, so a redirect through our clickworker can increase the percentage of non-revenue to the target link.
- You may feel uncomfortable that a third party is included in the redirect chain.
To solve these problems, we suggest downloading the clickworker and hosting 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 Meta 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.
Templates description
Name | Description | Note |
---|---|---|
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. | Required parameter |
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 | Available if the option Additional subs is enabled | - |
sub9 | Available if the option Additional subs is enabled | - |
sub10 | Available if the option Additional subs is enabled | - |
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). | Required parameter if the option Target URL is not enabled |
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: *