📘
This integration is currently in beta. Contact your MetaRouter support team to get started.

What Is adMarketplace?

adMarketplace is a digital advertising marketplace that enables advertisers and publishers to buy and sell performance-driven media. It provides technology to measure, optimize, and attribute traffic and conversion activity generated from adMarketplace campaigns. Advertisers can send conversion events directly to adMarketplace to connect on-site activity with prior ad clicks.

Product Type: Advertising

Integration Type: Starter Kit & ID Sync

Event Source Type: Web

Event Scope: Full-Funnel Events

Capabilities

Sends conversion and engagement events directly to adMarketplace via the Advertiser Event Data API.
Captures a configurable adMarketplace click ID from the URL for attribution.
Enriches all events with advertiser and event identifiers required by adMarketplace.
Supports full-funnel events including product, cart, checkout, and order lifecycle actions.

Considerations

event-id and advertiser-id are required for every event and must be provided by adMarketplace.
If conversion-time-source is set to 1, a valid ISO 8601 UTC conversion-time must also be sent.
The starter kit automatically sets conversion-time-source to 1 when a timestamp is included.
The AdMarketplace URL Decorator value in the sync must exactly match the value configured in the starter kit to ensure click IDs map correctly.
Authentication uses a Bearer token. A fixed partner access token is provided to MetaRouter and included in the starter kit by default.
Recommended request rate is 200 requests per second. If you anticipate higher throughput, coordinate with adMarketplace in advance to discuss scaling options, as exceeding this rate may result in temporary request rejection.
The API supports URLs up to 4096 characters, including the full query string.

Identity Sync

Sync Available: Yes
Required for Starter Kit: Highly Recommended
Prerequisites: Configured adMarketplace URL decorator parameter
Documentation: See Additional adMarketplace Documentation

Sync Details

Captures the adMarketplace click ID from a configurable URL parameter.
Stores the click ID in first-party storage for a defined cookie lifetime.
Appends the resolved click ID to server-side events under context.providers.adMarketplace.
Required to associate conversions with prior adMarketplace ad clicks.

Starter Kit Setup Guide

1. Deploy the adMarketplace Sync

To collect the required click ID value, you must implement an adMarketplace ID sync. Refer to the following documentation to complete the setup: adMarketplace - ID Sync Guide.

2. Gather Credentials

Ask adMarketplace representatives for the following credentials:
- Advertiser ID
- Event IDs for each tracked event

3. Add an adMarketplace Integration

From the integration library, add an adMarketplace integration. Then, fill out the Connection Parameters:

Connection Parameter	Description
`ACCESS_TOKEN`	Bearer token used to authenticate API requests. This token is provided at the partner level and is preconfigured in the starter kit. Do not modify unless instructed by your adMarketplace representative.
`API_ENDPOINT_URL`	API endpoint for sending conversion events. Defaults to adMarketplace's production endpoint.

4. Configure Event Mapping

MetaRouter provides all of the event mappings that adMarketplace integrations typically require. You may add custom events or parameters in accordance with adMarketplace’s API documentation. Contact your adMarketplace representative to obtain the most current documentation.

5. Deploy to Pipeline

In the Pipelines tab, add your adMarketplace integration.
Select the correct integration revision.
Click Add Integration to finalize deployment.

Event Mappings

Global

Global mappings will be applied to all events. If your parameter names do not match the Expected Inputs provided, you will need to overwrite the Inputs provided with your own.

Output Key	Description	Expected Input
`advertiser-id` Required	String: Advertiser account ID provided by adMarketplace.	$$ADVERTISER_ID$$
`conversion-time-source`	String: Determines how conversion time is set (`'0'` or `'1'`).	Enrichment – '1'
`click-id`	String: Click ID captured by the adMarketplace sync (URL decorator value).	context.providers.adMarketplace.$$AD_MARKETPLACE_URL_DECORATOR$$
`custom-info`	String: Event label for reporting (normalized event name or type).	Expression – lowercases and replaces spaces with underscores
`conversion-time`	String: Conversion time in ISO 8601 UTC; required when `conversion-time-source` is `'1'`.	Expression – derived from input timestamp

Event Specific

Identify

Output Key	Description	Expected Input
`event-id` Required	String: Event identifier supplied by adMarketplace.	Enrichment – "ADD_EVENT_ID_HERE"

Page

Output Key	Description	Expected Input
`event-id` Required	String: Event identifier supplied by adMarketplace.	Enrichment – "ADD_EVENT_ID_HERE"

Product List Viewed

Output Key	Description	Expected Input
`event-id` Required	String: Event identifier supplied by adMarketplace.	Enrichment – "ADD_EVENT_ID_HERE"
`product-category`	String: Product category associated with viewed items.	properties.category

Product Clicked

Output Key	Description	Expected Input
`event-id` Required	String: Event identifier supplied by adMarketplace.	Enrichment – "ADD_EVENT_ID_HERE"
`product-category`	String: Product category of clicked item.	properties.category
`order-value`	Float: Calculated total value from product properties.	Expression – TOTAL_VALUE(input.properties)

Product Viewed

Output Key	Description	Expected Input
`event-id` Required	String: Event identifier supplied by adMarketplace.	Enrichment – "ADD_EVENT_ID_HERE"
`product-category`	String: Product category of viewed item.	properties.category
`order-value`	Float: Calculated total value from product properties.	Expression – TOTAL_VALUE(input.properties)

Product Added

Output Key	Description	Expected Input
`event-id` Required	String: Event identifier supplied by adMarketplace.	Enrichment – "ADD_EVENT_ID_HERE"
`product-category`	String: Product category of added item.	properties.category
`order-value`	Float: Calculated total value from product properties.	Expression – TOTAL_VALUE(input.properties)

Product Removed

Output Key	Description	Expected Input
`event-id` Required	String: Event identifier supplied by adMarketplace.	Enrichment – "ADD_EVENT_ID_HERE"
`product-category`	String: Product category of removed item.	properties.category
`order-value`	Float: Calculated total value from product properties.	Expression – TOTAL_VALUE(input.properties)

Cart Viewed

Output Key	Description	Expected Input
`event-id` Required	String: Event identifier supplied by adMarketplace.	Enrichment – "ADD_EVENT_ID_HERE"
`order-value`	Float: Total cart value.	Expression – TOTAL_VALUE(input.properties.products)

Checkout Started

Output Key	Description	Expected Input
`event-id` Required	String: Event identifier supplied by adMarketplace.	Enrichment – "ADD_EVENT_ID_HERE"
`order-value`	Float: Checkout total value.	properties.value
`unique-id`	String: Unique order identifier.	properties.order_id

Payment Info Entered

Output Key	Description	Expected Input
`event-id` Required	String: Event identifier supplied by adMarketplace.	Enrichment – "ADD_EVENT_ID_HERE"
`unique-id`	String: Unique order identifier.	properties.order_id

Order Completed

Output Key	Description	Expected Input
`event-id` Required	String: Event identifier supplied by adMarketplace.	Enrichment – "ADD_EVENT_ID_HERE"
`order-value`	Float: Final order revenue amount.	properties.total
`unique-id`	String: Unique order identifier used for deduplication.	properties.order_id

Promotion Clicked

Output Key	Description	Expected Input
`event-id` Required	String: Event identifier supplied by adMarketplace.	Enrichment – "ADD_EVENT_ID_HERE"

Promotion Viewed

Output Key	Description	Expected Input
`event-id` Required	String: Event identifier supplied by adMarketplace.	Enrichment – "ADD_EVENT_ID_HERE"

Product Added To Wishlist

Output Key	Description	Expected Input
`event-id` Required	String: Event identifier supplied by adMarketplace.	Enrichment – "ADD_EVENT_ID_HERE"
`product-category`	String: Product category of wishlist item.	properties.category
`order-value`	Float: Calculated total value from product properties.	Expression – TOTAL_VALUE(input.properties)

Order Updated

Output Key	Description	Expected Input
`event-id` Required	String: Event identifier supplied by adMarketplace.	Enrichment – "ADD_EVENT_ID_HERE"
`order-value`	Float: Updated order total.	properties.total
`unique-id`	String: Unique order identifier.	properties.order_id

Order Refunded

Output Key	Description	Expected Input
`event-id` Required	String: Event identifier supplied by adMarketplace.	Enrichment – "ADD_EVENT_ID_HERE"
`order-value`	Float: Refunded amount.	properties.total
`unique-id`	String: Unique order identifier.	properties.order_id

Order Canceled

Output Key	Description	Expected Input
`event-id` Required	String: Event identifier supplied by adMarketplace.	Enrichment – "ADD_EVENT_ID_HERE"
`order-value`	Float: Canceled order amount.	properties.total
`unique-id`	String: Unique order identifier.	properties.order_id

Coupon Entered

Output Key	Description	Expected Input
`event-id` Required	String: Event identifier supplied by adMarketplace.	Enrichment – "ADD_EVENT_ID_HERE"
`unique-id`	String: Unique order identifier.	properties.order_id

Products Searched

Output Key	Description	Expected Input
`event-id` Required	String: Event identifier supplied by adMarketplace.	Enrichment – "ADD_EVENT_ID_HERE"

Required & Recommended Identifiers

These identifiers must be mapped to adMarketplace in order for successful user matching to occur. Without these IDs, any events sent to adMarketplace may not be accurately reflected in reporting.

Attribute	Example	Sync Injector Required?
`click-id` Recommended	`456825931450256319`	Yes

Integration Validation

Ask your adMarketplace representative to confirm that events are being received and processed on their backend.
If available, request a staging or test endpoint from adMarketplace before launching to production.
When troubleshooting, provide the requestId from the API response to your adMarketplace representative.