Manual S2S integration
Server-to-server conversion tracking - manual integration.
Overview
This topic describes how to set up S2S (server-to-server) conversion tracking manually.
Intended audienceThis flow requires some technical knowledge.
Custom developmentCustom development is required (in order to pass the event to Taboola).
MMPs & 3rd party platformsIf you are using a MMP (Mobile Measurement Partner) to track your app conversions, see: S2S conversion tracking with MMP platforms
If you are using a third party platform to track your conversions, see: S2S conversion tracking with third party platforms
Realize
Create an event-based conversion rule
The instructions below illustrate how to track an app Install conversion.
Similar steps can be taken for other conversions - e.g. in-app events.
For an alternative use case - tracking CRM-based conversions - see the Help Center.
-
Open Realize, and select the account (top, right) that you will use to track this conversion.
-
In the sidebar (left), select
Tracking. -
Click on
+ CREATE(far right) and selectConversion.For some accounts, this button is labelled
+ New Conversion. -
Type in a
Conversion Nameof your choice - e.g.App install.This is a descriptive name for your convenience. It is not used for matching purposes.
-
For
Conversion Type, selectEVENT:
-
(Optional) If relevant, fill in a
Fixed Value.Tip: If the event returns a dynamic value, leave this field blank. For additional guidelines, see the Help Center.
-
Scroll through the list of categories provided and select the relevant
Category- e.g.App Install. -
(Optional) If desired, edit the
Event Name. For example, you might prefer the nameinstall, in place ofapp_install.You will need to pass the event name - exactly as entered here - via the postback URL. If the naming convention is not identical, Taboola will not receive the event.
-
(Optional) If desired, edit the following fields:
Click Through Conversion WindowView Through Conversion Window
-
(Optional) If relevant, clear the
Include in total conversionscheckbox.Tip: Always include the most important conversions, so that the Taboola algorithm will optimize towards them. For additional guidelines, see the Help Center.
-
(Optional) If relevant, clear the
Include in total valuecheckbox. -
(Optional) If desired, edit the following fields:
Audience PropertiesAggregation Type
-
Skip the
Event Codesection.(You will post the event values to Taboola via the Postback URL.)
-
Review your chosen settings, and click on
Create(bottom, right):
Add the Click ID macro
Add the Click ID macro to your campaign:
-
Open Realize, and select the account (top, right) that is running the campaign.
-
Locate the relevant campaign and click on the
Edit Campaignicon:
-
Within the campaign settings, scroll down to the
</> Trackingsection. -
Append the following snippet to the existing query string:
&click_id={click_id}ExampleOriginal string:
utm_source=taboola&utm_medium=referralUpdated string:utm_source=taboola&utm_medium=referral&click_id={click_id}ImportantEnter the value on the right exactly as shown above:
{click_id}OptionalYou can edit the param name on the left - but make sure your web page uses the identical name.
Example:
If you append
&tbl_click_id={click_id}, then your web page must look for a param calledtbl_click_id. -
Click on
Save(bottom, right):
The Click IDWhen your ad displays, the Click ID macro generates an actual Click ID value.
This is a case-sensitive string of variable length (approx 120 chars). It looks something like this:
tblzFZwgwCiBdupCXVpES7FFRezBmaMqFWoprNPZbbq4Z_zMDu-XC_BC5YBiewdbqytuYAiC5YCi5YDC5YDiewdbqytuYAkAAMqFWoprNPZbbq4ZMake sure to pass the string 'as is'. A truncated (or otherwise corrupted) value will be ignored.
Pass the event data to Taboola
Overview
Now that you have defined an event-based conversion - and added the Click ID macro to your campaign - you need some way to pass the event data to Taboola.
2 methods are supported:
For an overview of the end-to-end flow, refer to the next section.
End-to-end flow
- You append the Click ID macro in Realize (previous section):
...&click_id={click_id} - When your ad displays, an actual Click ID value is appended to the target URL:
https://example.com/landing_page?...&click_id=a1b2c3d4e5f6 - Your landing page looks for the relevant param (
click_id) and grabs the value (a1b2c3d4e5f6). - Your server is responsible to pass the event data to Taboola. 2 methods are supported:
- The postback URL
For each conversion, invoke the postback URL. Use query params (e.g.
click_id) to pass the event data for that conversion. - Bulk submit conversions
Pass a
JSONobject with event data (e.g.click_id) for multiple conversions.
- The postback URL
The sections that follow describe the postback URL and bulk submission flows.
Updated about 2 months ago
