Konverzní kódy

Tuhle funkci využijete pro odesílání informací o nákupech do analytických nástrojů jako jsou google analytics, google tag manager, facebook pixel aj.

Zpracování a odeslání dat z FAPI dělá jednoduchý script, který načte všechna data objednávky a ve zvoleném systému automaticky vytvoří konverzi.

Konverze si do analytických nástrojů můžete sestavit i sami a doplnit je o další informace, které vám pomohou k analýze vašich prodejů.

Také můžete odeslat konverze do nástrojů, pro které nemáme připravenou podporu. 

FAPI asistent

Chcete si nechat konverzní kódy nastavit? Využijte naši službu FAPI asistent.

Co je potřeba?

  1. Do vaší vlastní děkovací stránky je potřeba vložit kód, který načítá informace o objednávce.
  2. V úpravě prodejního formuláře(krok 5. děkovací stránka) je potřeba mít zaškrtnutý checkbox "Vkládat unikátní identifikátor objednávky do URL děkovací stránky.
  3. Váš web musí běžet na https, jinak se data objednávky nenačtou.
  4. Musíte mít na vašem webu inicializované analytické nástroje jako GTM, FB pixel, Google Analytics, jinak se data do těchto nástrojů nepošlou.
  5. Script a konverzní kódy vkládejte nejlépe do patičky vašeho webu.

Script, který je potřeba vložit na vaší děkovací stránku:

<script src="https://form.fapi.cz/js/sdk/fapi.js"></script>

Tento kód, se spojením s unikátním identifikátorem objednávky, zajišťuje stažení informací o objednávce z FAPI do vaší děkovací stránky. 

Díky tomu můžete konverze zaslat do jakéhokoliv analytického nástroje. 

Jak tyto funkce použít?

Ukázka zaslání dat do FB pixelu:
<script>
document.addEventListener('FapiSdkLoaded', function () {
	FAPI_CONVERSION.runConversion(function (fapiOrderData) {
		FAPI_CONVERSION.simpleFacebookPixelTransaction(fapiOrderData);
	});
});
</script>
<script src="https://form.fapi.cz/js/sdk/fapi.js"></script>
Ukázka zaslání dat do GTM:
<script>
document.addEventListener('FapiSdkLoaded', function () {
	FAPI_CONVERSION.runConversion(function (fapiOrderData) {
		FAPI_CONVERSION.simpleGoogleTagManagerTransaction(fapiOrderData);
	});
});
</script>
<script src="https://form.fapi.cz/js/sdk/fapi.js"></script>
Ukázka zaslání dat do Google Analytics:
<script>
document.addEventListener('FapiSdkLoaded', function () {
	FAPI_CONVERSION.runConversion(function (fapiOrderData) {
		FAPI_CONVERSION.simpleGoogleAnalyticsEcommerceTransaction(fapiOrderData);
	});
});
</script>
<script src="https://form.fapi.cz/js/sdk/fapi.js"></script>
Ukázka zaslání konverzí do Affilboxu:
<script>
document.addEventListener('FapiSdkLoaded', function () {
	FAPI_CONVERSION.runConversion(function (fapiOrderData) {
		FAPI_CONVERSION.simpleAffilboxTransaction(fapiOrderData, 'demo.affilbox.cz', '1');
	});
});
</script>
<script src="https://form.fapi.cz/js/sdk/fapi.js"></script>
Pokud chcete odeslat konverze do více nástrojů, můžete tyto kódy zjednodušit takto:
<script>
document.addEventListener('FapiSdkLoaded', function () {
	FAPI_CONVERSION.runConversion(function (fapiOrderData) {   
		FAPI_CONVERSION.simpleFacebookPixelTransaction(fapiOrderData);
		FAPI_CONVERSION.simpleGoogleTagManagerTransaction(fapiOrderData);
		FAPI_CONVERSION.simpleGoogleAnalyticsEcommerceTransaction(fapiOrderData);
	});
});
</script>
<script src="https://form.fapi.cz/js/sdk/fapi.js"></script>
Dále se dají použít funkce, které pošlou data do analytických nástrojů jen když jsou dané objednávky zaplacené:
<script>
document.addEventListener('FapiSdkLoaded', function () {
	FAPI_CONVERSION.runConversion(function (fapiOrderData) {
		FAPI_CONVERSION.simpleFacebookPixelTransactionOnlyPaid(fapiOrderData);
		FAPI_CONVERSION.simpleGoogleTagManagerTransactionOnlyPaid(fapiOrderData);
		FAPI_CONVERSION.simpleGoogleAnalyticsEcommerceTransactionOnlyPaid(fapiOrderData);
	});
});
</script>
<script src="https://form.fapi.cz/js/sdk/fapi.js"></script>
V případě, že potřebujete data odeslat do nějakého jiného nástroje, pro který funkci nemáme, můžete si data objednávky namapovat do analytického nástroje sami. 
Ukázka pro sKlik.cz:
<script>
document.addEventListener('FapiSdkLoaded', function () {
FAPI_CONVERSION.runConversion(function (fapiOrderData) {
	var conversionConf = {
		id: fapiOrderData['number'], /* číslo objednávky */
		value: fapiOrderData['total_amount'], /* hodnota objednávky v Kč bez DPH*/
		consent: 1 /* souhlas od návštěvníka na odeslání konverzního hitu, povolené hodnoty: 0 (není souhlas) nebo 1 (je souhlas) */
	};
	// Ujistěte se, že metoda existuje, předtím než ji zavoláte
	if (window.rc && window.rc.conversionHit) {
		window.rc.conversionHit(conversionConf);
	}
});
});
</script>
<script src="https://form.fapi.cz/js/sdk/fapi.js"></script>

Jaká data jdou dostupné v proměnné fapiOrderData? 

Dostupné parametry a jejich vysvětlivky jsme popsali v API dokumentaci: https://web.fapi.cz/api-doc/#api-OrderConversion-GetOrderConversion

Zde najdete všechny dostupné parametry, se kterými můžete pracovat, i s vysvětlivkami, jaké hodnoty obsahují.

Předdefinované funkce

Tento script vytvoří objekt FAPI_CONVERSION, který má přístupné tyto funkce:

FAPI_CONVERSION.runConversion(onSuccess: callback)

Toto je výchozí funkce pro získání dat objednávky a spuštění konverzních kódů.

Dále při spuštění této funkce vloží informace o objednávce do Google Tag Manageru. Pomocí eventu "fapiOrderDataLoaded" a data objednávky jsou následně uložena pod klíčem "fapiOrderData". Dále se tedy s objednávkou dá pracovat přimo v GTM.

Po načtení dat objednávky tato funkce taky vyvolá event "fapiOrderDataLoaded", kde v detailu eventu pod klíčem "fapiOrderData", jsou uložena data objednávky. Použití je možné pro vlastní zpracování konverzí.

FAPI_CONVERSION.simpleFacebookPixelTransaction(fapiOrderData: object)

Tato funkce vytvoří konverzi ve Facebook pixelu. Data nejsou odeslaná do FB Pixelu, pokud na stránce nemáte FB Pixel nainstalovaný.

FAPI_CONVERSION.simpleFacebookPixelTransactionOnlyPaid(fapiOrderData: object)

Tato funkce vytvoří konverzi ve Facebook pixelu, pouze pokud je objednávka zaplacená. Data nejsou odeslaná, pokud na stránce nemáte FB Pixel nainstalovaný.

FAPI_CONVERSION.simpleGoogleTagManagerTransaction(fapiOrderData: object)

Tato funkce vytvoří konverzi v Google Tag Manageru. Data nejsou odeslaná do GTM pokud na stránce nemáte GTM nainstalovaný.

FAPI_CONVERSION.simpleGoogleTagManagerTransactionOnlyPaid(fapiOrderData: object)

Tato funkce vytvoří konverzi ve Google Tag Manageru, pouze pokud je objednávka zaplacená.  Data nejsou odeslaná do GTM pokud na stránce nemáte GTM nainstalovaný.

FAPI_CONVERSION.simpleGoogleAnalyticsEcommerceTransactionTransaction(fapiOrderData: object)

Tato funkce vytvoří konverzi v Google Analytics. Data nejsou odeslaná do Google Analytics pokud na stránce nemáte Google Analytics nainstalovaný.

FAPI_CONVERSION.simpleGoogleAnalyticsEcommerceTransactionTransactionOnlyPaid(fapiOrderData: object)

Tato funkce vytvoří konverzi ve Google Analytics, pouze pokud je objednávka zaplacená. Data nejsou odeslaná do Google Analytics pokud na stránce nemáte Google Analytics nainstalovaný.

FAPI_CONVERSION.simpleAffilboxTransaction(fapiOrderData: object, url: string, campaignId: string|int)

Tato funkce vytvoří konverzi v Affilboxu

Tato funkce narozdíl od výše uvedených přijmá 2 argumenty. Url adresu a ID kampaně:

  • url - tuto url najdete v administraci Affilboxu - konverzní kódy a je to hodnota proměnné "ab_instance", která bude v podobném tvaru: "demo.affiliate.cz"
  • campaignId - ID kampaně najdete také v administraci Affilixu - konverzní kódy a je to hodnoha proměnné ab_kampan, kde hodnova je číslo kampaně, například: '1'
FAPI_CONVERSION.simpleAffilboxTransactionOnlyPaid(fapiOrderData: object, url: string, campaignId: string|int)

Tato funkce vytvoří konverzi v Affilboxu, pouze pokud je objednávka zaplacená. 

Tato funkce má stejné fungování jako "simpleAffilboxTransaction".