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.
Product Type: Advertising
Integration Type: Starter Kit & ID Sync
Event Source Type: Web
Event Scope: Full-Funnel Events
Capabilities
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.
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.
Supports two sync methods: Tag Sync (client-side tag load) and Fetch Sync (server-side sync request).
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.
Allows delivery of enriched commerce metadata including product lists, SKUs, order data, and total purchase value.
Considerations
Data center selection (us, ams, asia) should match the geographic region of your users.
Cookie matching is available only for Fetch Sync and requires enabling the Allow Cookie Matching setting and configuring Allowed Cookie Matching Endpoints.
Tag Sync loads the RTB House tag in the client browser, while Fetch Sync performs a server-initiated sync. Select the appropriate type based on your deployment requirements.
Identity Sync
Sync Available: Yes
Required for Starter Kit: Yes
Prerequisites: Tagging Hash, Data Center selection, chosen Sync Type (Tag Sync or Fetch Sync)
Documentation: See Additional RTB House Sync Documentation
Sync Details
Sends MetaRouter’s ajsid to RTB House via a POST request for identity synchronization.
Enables personalized retargeting by syncing users to RTB House’s platform.
Supports regional data routing through configurable data center endpoints.
Tracks sync status with a locally stored value used to determine re-sync timing.
When using Fetch Sync, supports optional cookie matching. RTB House may return a list of partner sync URLs (IMG or IFRAME) used to link user identities across advertising vendors. MetaRouter filters these URLs using the customer-defined Allowed Cookie Matching Endpoints array, firing only the partner URLs that the customer has approved and user has consented for.
When using Tag Sync, loads the RTB House tag directly on the page for client-side identity synchronization.
Starter Kit Setup Guide
1. Deploy the RTB House Sync
To collect sync values and ensure identity alignment, you must implement the RTB House ID Sync. Refer to the RTB House – ID Sync Guide in the documentation section.
2. Gather Credentials
Tagging Hash – Provided by your RTB House representative.
Data Center – Region for routing (us, ams, or asia).
Partner Key – Provided by RTB House.
3. Add a 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.
4. Configure Event Mapping
MetaRouter provides all recommended mappings required for RTB House’s Event API. You may add additional events or fields if your RTB House implementation requires them.
5. Deploy to Pipeline
In the Pipelines tab, add your RTB House integration.
Select the correct integration revision.
Click Add Integration to finalize deployment.
Event Mappings
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.
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.
