This integration is currently in beta. Contact your MetaRouter support team to get started.
What Is RTB House?
RTB House is a cutting-edge advertising platform designed to deliver personalized retargeting solutions powered by proprietary deep learning algorithms. It enables businesses to re-engage users with tailored ads across the web, leveraging real-time bidding (RTB) to secure optimal ad placements. The platform’s advanced technology ensures precise audience targeting, boosting campaign performance and driving higher conversions. With RTB House, you can optimize your ad spend, enhance user engagement, and achieve measurable results that align with your marketing goals.
What are the benefits of integrating MetaRouter with RTB House?
Identity Mapping: Synchronize user data efficiently with RTB House to enhance audience targeting.
Advanced Event Tracking: Capture detailed event data, including purchases, with customizable configurations tailored for RTB House.
Streamlined Integration: Deliver clean, enriched data directly to RTB House without the need for additional client-side setup.
Capabilities and Considerations
Event API: Supports event tracking through the RTB House Event API, enabling integration of order completed events with detailed metadata, such as user IDs, timestamps, and product information.
Identity Sync: Utilizes the RTB House sync injector to send the AJSID (anonymous ID) to RTB House for user synchronization. This ensures proper mapping for targeted advertising.
Attribution: Includes key parameters, such as sr (site referrer) and su (site URL), in API requests to support RTB House's conversion attribution system. This helps track and attribute user actions accurately for optimized campaign performance.
Getting Started - From Your RTB House Account
Determine the Data Center value for your starter kit and sync injector setup:
Data Center specifies the data center location for processing requests based on user region:
ams - use for European and African users
asia - use for Asian and Australian users
us - use for North and South American users
Obtain the following from your RTB House representative:
Partner Key
Tagging Hash
Getting Started - From Your MetaRouter Account
Adding an RTB House integration.
From the integration library, add an RTB House integration. Then, fill out the Connection Parameters:
Connection Parameter
Description
DATA_CENTER
Specifies the data center location for processing requests based on user region. ams - use for European and African users, asia - use for Asian and Australian users, us - use for North and South American users
PARTNER_KEY
A unique identifier assigned to each client for authenticating and tracking RTB House integrations.
TAGGING_HASH
A unique identifier used for tagging events and associating them with the appropriate RTB House account.
Adding an RTB Sync
The RTB House identity sync sends the AJSID to RTB House via a POST request to establish system synchronization and user mapping, and it is a mandatory step for the RTB House integration to function. Please see instructions below to add the RTB House identity sync.
From the Pipelines page, find the pipeline associated with the web property you’d like to add a sync to. Hover over the three dot dropdown and select “Build AJS File.”
In the Identity Syncs section, select the RTB House sync.
Fill out the following fields:
Data Center:
ams - use for European and African users
asia - use for Asian and Australian users
us - use for North and South American users
Tagging Hash - A unique identifier used for tagging events and associating them with the appropriate RTB House account.
Lifetime (in days) - 30 days default. Days before identity sync refreshes for a new ID.
API Timeout (in milliseconds) - 300 seconds default. Defines the maximum time, in milliseconds, that the system will wait for a response from the RTB House API.
Scroll down and click the Save and Build File button.
Deploy your AJS file to propagate changes to your web property.
Event Mappings
MetaRouter provides all of the event mappings that RTB House integrations typically require. You may add custom events, parameters or mappings in accordance with RTB House’s API documentation.
Global
Output Key
Description
Expected Input
pkey
String: The partner key to identify the RTB House client in the integration.
Enrichment – PARTNER_KEY value
aid
String: The anonymous user ID to track user interactions.
anonymousId
time
String: The timestamp of the event in milliseconds since UNIX epoch for precise event tracking.
Expression – Converts the input timestamp fields (timestamp, originalTimestamp, sentAt) using a Lua function.
su
String: Encoded URL of the page.
Expression – Encodes the input context.page.url to a URI-compliant format.
sr
String: Encoded referrer URL.
Expression – Encodes the input context.page.referrer to a URI-compliant format.
Event Specific
Identify
Output Key
Description
Expected Input
tag
String: Represents a hashed user identifier (e.g., email or phone) and event metadata.
Expression – Hashes the email or phone using SHA256 and prefixes it with pr_$$TAGGING_HASH$$_uid.
Page
Output Key
Description
Expected Input
tag
String: Represents the type of page being viewed. By default, if the page path is /, the tag is set to "home". This tag is prefixed with pr_$$TAGGING_HASH$$ to construct the final value (e.g., pr_<TAGGING_HASH>_home). Users can customize this logic to assign tags for other page types as needed.
Expression – Constructs the tag based on the page path: - Default: If context.page.path == '/', the tag is set to "home". - Example output: pr_<TAGGING_HASH>_home. - Customization: Update the Lua script to define tags for other paths (e.g., /category/ -> "category", /product/ -> "product").
Products Searched
Output Key
Description
Expected Input
tag
String: Represents the product search event. By default, the integration includes empty product ID fields to ensure compliance with standard AJS e-commerce event specs and maintain agnosticism.
Enrichment – Static string: pr_$$TAGGING_HASH$$_listing_. Note: Customers can customize the logic to include the first product IDs in the event if applicable.
Product List Viewed
Output Key
Description
Expected Input
tag
String: Represents the product list view event, including category or list ID.
Expression – Constructs a tag for the event, prefixed with pr_$$TAGGING_HASH$$_category2.
Product Viewed
Output Key
Description
Expected Input
tag
String: Represents the product view event, including product ID or SKU.
Expression – Constructs the tag for the event, prefixed with pr_$$TAGGING_HASH$$_offer.
Product Added
Output Key
Description
Expected Input
tag
String: Represents the product add event, including product ID or SKU.
Expression – Constructs the tag for the event, prefixed with pr_$$TAGGING_HASH$$_basketadd.
Product Added to Wishlist
Output Key
Description
Expected Input
tag
String: Represents the product add to wishlist event, including product ID or SKU.
Expression – Constructs a tag for the event, prefixed with pr_$$TAGGING_HASH$$_wishlist.
Cart Viewed
Output Key
Description
Expected Input
tag
String: Represents the cart view event, including product IDs or SKUs.
Expression – Joins product IDs or SKUs of the products in the cart, prefixed with pr_$$TAGGING_HASH$$_basketstatus.
String: Represents the order completion event, including order ID, value, and product IDs.
Expression – Constructs a tag string by concatenating the event type, value, order ID, and product IDs, prefixed with pr_$$TAGGING_HASH$$_conversion_order_purchase.
Required Identifiers
These identifiers must be mapped to RTB House in order for successful user matching to occur. Without these IDs, any events sent to RTB House may not be accurately reflected in reporting. For your convenience, required IDs are mapped as Global parameters to ensure they are added to every event.
Attribute
Example
Sync Injector Required?
aid
130161d0-8fee-4167-aa4d-d151eed27c6b
Yes - Sync is required to send anonymous ID to the RTB House identity endpoint.
