Overview
RTB House Conversions API (CAPI) is a marketing technology company that provides campaigns, products and services to improve advertiser experiences. By integrating with Zeotap CDP, you can send real-time events from Zeotap’s Journeys module to the RTB House Conversions API, enhancing your targeting capabilities.Supported Identifiers and Attributes
This section provides information about the identifiers and attributes supported in RTB House CAPI:| Catalogue Field | Destination Field |
|---|---|
| Rtb_house_cookie | Rtb_House_cookie (String) |
| Event Timestamp | Event Timestamp |
| No pre-mapped field | Category ID (String) |
| No pre-mapped field | Product Offer event Product ID (String) |
| No pre-mapped field | Search Results event Product IDs (List) |
| No pre-mapped field | Add to Cart Product ID (String) |
| No pre-mapped field | Shopping Cart Status Product IDs (List) |
| No pre-mapped field | Order ID (String) |
| No pre-mapped field | Conversion Order Product IDs(List) |
| No pre-mapped field | Value (Integer) |
Prerequisites
Ensure that you have addressed the following prerequisites before starting the integration:- Obtain the Pkey and Tagging Hash by contacting your RTB House representative. In the RTB House Conversions API, a PKey, also known as an advertiser’s public key, is a unique string necessary for authentication and authorisation. In RTB House Conversions API, ‘Tagging hash’ is a static client tagging hash identifier.
- Notify RTB House of your intent to send server-to-server (S2S) requests so that they can enable the configuration on their end.
- Share the event name (key) for custom events with RTB House in advance so that they can configure it.
- Enable cookie syncing between Zeotap CDP and RTB House to use this integration.
Endpoints
To send information regarding specific user behaviour on your website, run the following HTTPS POST requests in the Linux command line as shown below. Example using curl in Linux command line:curl -v -X POST 'https://omni.creativecdn.com/partner/omni/postbacks? pkey=sRF5IDzkkpcO66MlPKEY &uid={{UID}} &time={{MSEC}} &tag=pr_sRF5IDzkkpcO66MlNsxS_{{EVENT}}'
Parameters
| Name | Description |
|---|---|
{{UID}} | Replace with the user ID (the same as passed via the web tag). This is the RTB House cookie. |
{{MSEC}} | Replace with the event time in milliseconds since the UNIX epoch (January 1, 1970 00:00:00 UTC). |
{{EVENT}} | Replace with a specific tag for different types of information (events). |
Event Types allowed to Send
| Event Name | Description |
|---|---|
| home | For visiting the home page of your website. |
category2_{{categoryID}} | For visiting a category page. Replace {{categoryID}} with the ID of a specific category. |
offer_{{ID}} | For visiting a product page. Replace {{ID}} with a unique product ID from the product feed. |
listing_{{ID}},{{ID}},{{ID}},{{ID}},{{ID}} | For visiting a search result page. Replace the {{ID}} macros with the IDs of products displayed on the page. The list can include up to 5 IDs; any IDs beyond this limit will be ignored. |
basketadd_{{ID}} | For adding a product to the cart. Replace the {{ID}} macro with the ID of the product just added to the cart, regardless of the quantity.Example: If the product with ID 12 is added to the cart, use basketadd_12. |
basketstatus_{{ID}},{{ID}},{{ID}},{{ID}},{{ID}} | For displaying a shopping cart page. Replace the {{ID}} macros with the IDs of all products currently in the shopping cart, regardless of quantity.Example: For a basket containing products with IDs 12, 14, 8, and 7, use basketstatus_12,14,8,7.4o mini |
| `startorder | For visiting the page that begins order processing, such as the checkout page after creating and filling the shopping cart. This is usually the contact details form or any page displayed after clicking “Go to checkout” or a similar button. |
conversion_order_purchase_{{VALUE}}{{ORDER-ID}}{{ID}},{{ID}},{{ID}}&cd={DEDUPLICATION} | For the order confirmation page. Trigger this code on the order confirmation page for all orders placed on your website, regardless of traffic source. Tagging confirmation is essential for proper customer segmentation, which helps optimise subsequent advertising space purchases. • Replace {{VALUE}} with the order value, formatted with a decimal point (dot or comma), without thousands separators.• Replace {{ORDER-ID}} with the internal (shop) order identifier.• Replace each {{ID}} with the IDs of products in the shopping cart.• Replace {{DEDUPLICATION}} with either false or true. Set to TRUE for all cases.Do not encode & to ensure that cd=… is treated as an additional parameter in the main request. |
| Custom Events | Send custom events to RTB House using the following format: custom_{{Event_Name}}_{{Value}}• Replace {{Event_Name}} with the name of the custom event.• {{Value}}can be a boolean or any ID relevant to the custom event.Examples: • custom_cartabandoned_true adds a user to the pool of users with abandoned carts. Here, cartabandoned is the event and true is the value. • custom_loyaltitypoints_100 indicates 100 loyalty points. Here, loyaltitypoints is the event and 100 is the value. Note: Ensure that you share the event name (key) with RTB House in advance for proper configuration. |
Components of RTB House Conversion API
Ensure that you have the details about the below components of RTB House Conversions API account before starting this integration.PKey
In the RTB House Conversions API, a PKey, also known as an advertiser’s public key, is a unique string necessary for authentication and authorisation. Reach out to the RTB House CAPI representative to obtain this information.Tagging Hash
In the RTB House Conversions API, a Tagging hash is a static client tagging hash identifier. Reach out to the RTB House CAPI representative to obtain this information.Destination Setup
After you have applied filters or added conditions for your users in Journeys, you can activate them in RTB House CAPI under Send to Destinations. A new window appears, where you can set up your destination. You can use an already existing destination from the list of available Destinations **** or create a new one by clicking + Add New Destination.
Add New Destination
Perform the following steps to add a new destination:
Enter the PKey and Tagging Hash obtained from the RTB house representative. These two fields serve as credentials for authorising you on the RTB House platform.
In the mapping screen that appears, under Choose your Action, select Send events to RTB House as the action for sending data from the workflow created in Journeys. Under Map the Fields, a list of identifiers and attributes are populated. Ensure that you map only the relevant attributes corresponding to the event selected while creating the destination. Use the Catalogue Field and Destination Field columns to map the required attributes. Learn more
Activate the Destination on Journeys
After creating a destination, next, you need to link it in the Send to Destination node within the workflow, as explained below.
Under the Destination Details tab, the Pkey and Tagging Hash fields are automatically populated based on the value that you had entered while creating the destination. However, you need to choose the Event Type from the drop-down based on your requirement.
