Documentation

Clinch

Suggest Edits

What Is Clinch?

Clinch is a dynamic creative optimization platform that empowers advertisers to create personalized, data-driven ad experiences at scale. By leveraging artificial intelligence and machine learning algorithms, Clinch enables advertisers to dynamically generate and deliver tailored ad content to individual users across various digital channels. Its intuitive platform allows advertisers to easily create, manage, and optimize campaigns, while providing robust analytics and insights to drive better performance and ROI. Clinch's technology helps advertisers engage audiences more effectively by delivering relevant messages based on real-time data, enhancing ad effectiveness and campaign success.

What are the benefits of integrating Clinch with MetaRouter?

  • Enables Clinch tag removal.
  • No effect on website load latency.
  • Ensures event data is streaming into Clinch for accurate ad decisioning and measurement.
  • All customer data events and attributes unlocked for custom event mapping and transformation.

Getting Started - From Your Clinch Account

You will need the following IDs from the Clinch platform. Both IDs must be the encoded IDs:

  • Client ID
    1. Navigate to the Flight Control platform.
    2. Locate the Client ID within the account settings section, or alternatively, consult your Clinch Account Manager for assistance.
  • Data Source ID
    1. Access the Flight Control platform.
    2. Retrieve the Data Source ID during the creation of a new data source, or seek guidance from your Clinch Account Manager.

For further clarification on the aforementioned IDs, please do not hesitate to contact your designated Clinch support representative.

Getting Started - From Your MetaRouter Account

Adding a Clinch integration.

From the integration library, add a Clinch integration. Then, fill out the Connection Parameters:

Connection ParameterDescription
CLIENT_IDYour Client ID.
DATA_SOURCE_IDYour Data Source ID.
PARTNER_IDThe default value is static for the MetaRouter to Clinch integration. Please do not change this unless advised by your Clinch rep.

Adding a Clinch Sync

To gather the clickClickID value and the clinch-sid value, you must add a Clinch sync.

  1. 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.”
  2. In the Identity Syncs section, select the Clinch sync.
  3. Fill out the following fields:
    1. Consent Type - We recommend that you consult with your legal team when determining your consent requirements.
    2. Client ID(s) - Please input your Client ID in the following format [”XXXXXX”].
    3. Cookie Lifetime - Recommended 90 days.
  4. Scroll down and click the Save and Build File button.
  5. Deploy your AJS file to propagate changes to your web property.

Event Mappings

MetaRouter provides all of the event mappings that Clinch integrations typically require. You may add custom events, parameters or mappings in accordance with Clinch’s API documentation.

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 KeyDescriptionExpected Input
cid
Required		Type: String
Client ID (encoded).		CLIENT_ID
dsid
Required		Type: String
Data Source ID (encoded).		DATA_SOURCE_ID
partner
Required		Type: Numeric
Vendor partner ID on Clinch.		PARTNER_ID
timestamp
Required		Type: Epoch MS Format
Event time stamp in UTC.		N/A - Expression
user_ip
Required		Type: String
IP V4.		context.ip
user_agent
Required		Type: String
User agent.		context.userAgent
referrer
Required		Type: Encoded URL
The page URL where the event originated from.		context.page.referrer
hem
Highly Recommended		Type: SHA-256
Hashed email address.		N/A - Expression

Event Specific


identify

Output KeyDescriptionExpected Input
type
Required		Type: String
Event type.		Other

page

Output KeyDescriptionExpected Input
type
Required		Type: String
Event type.		PageView

products_searched

Output KeyDescriptionExpected Input
type
Required		Type: String
Event type.		Search
term
Optional		Type: String
Search term.		properties.query

product_list_viewed

Output KeyDescriptionOutput Key
type
Required		Type: String
Event type.		Category
product
Required		Type: String
One of Ecommerce, Flight, Hotel, Package, Car		Default: Ecommerce
category
Optional		Type: String
Product category.		properties.category
ids
Optional		Type: Comma-separated String
Viewed Product IDs.		product_id
amount
Optional		Type: Number
Total price amount.		N/A - Expression
currency
Optional		Type: String
Currency code, i.e. (USD).		properties.currency

product_viewed

Output KeyDescriptionOutput Key
type
Required		Type: String
Event type.		Details
product
Required		Type: String
One of Ecommerce, Flight, Hotel, Package, Car		Default: Ecommerce
category
Optional		Type: String
Product category.		properties.category
ids
Optional		Type: Comma-separated String
Viewed Product IDs.		product_id
amount
Optional		Type: Number
Total price amount.		N/A - Expression
currency
Optional		Type: String
Currency code, i.e. (USD).		properties.currency

product_added

Output KeyDescriptionOutput Key
type
Required		Type: String
Event type.		AddtoCart
product
Required		Type: String
One of Ecommerce, Flight, Hotel, Package, Car		Default: Ecommerce
category
Optional		Type: String
Product category.		properties.category
ids
Optional		Type: Comma-separated String
Viewed Product IDs.		product_id
amount
Optional		Type: Number
Total price amount.		N/A - Expression
currency
Required		Type: String
Currency code, i.e. (USD).		properties.currency

product_added_to_wishlist

Output KeyDescriptionOutput Key
type
Required		Type: String
Event type.		AddToWishList
product
Required		Type: String
One of Ecommerce, Flight, Hotel, Package, Car		Default: Ecommerce
category
Optional		Type: String
Product category.		properties.category
ids
Optional		Type: Comma-separated String
Viewed Product IDs.		product_id
amount
Optional		Type: Number
Total price amount.		N/A - Expression
currency
Optional		Type: String
Currency code, i.e. (USD).		properties.currency

product_removed

Output KeyDescriptionOutput Key
type
Required		Type: String
Event type.		RemFromCart
product
Required		Type: String
One of Ecommerce, Flight, Hotel, Package, Car		Default: Ecommerce
category
Optional		Type: String
Product category.		properties.category
ids
Optional		Type: Comma-separated String
Viewed Product IDs.		product_id
amount
Optional		Type: Number
Total price amount.		N/A - Expression
currency
Optional		Type: String
Currency code, i.e. (USD).		properties.currency

cart_viewed

Output KeyDescriptionOutput Key
type
Required		Type: String
Event type.		CartPage
product
Required		Type: String
One of Ecommerce, Flight, Hotel, Package, Car		Default: Ecommerce
ids
Optional		Type: Comma-separated String
Viewed Product IDs.		product_id
amount
Optional		Type: Number
Total price amount.		N/A - Expression
currency
Optional		Type: String
Currency code, i.e. (USD).		properties.currency

checkout_started

Output KeyDescriptionOutput Key
type
Required		Type: String
Event type.		Checkout
product
Required		Type: String
One of Ecommerce, Flight, Hotel, Package, Car		Default: Ecommerce
ids
Optional		Type: Comma-separated String
Viewed Product IDs.		product_id
amount
Optional		Type: Number
Total price amount.		N/A - Expression
currency
Optional		Type: String
Currency code, i.e. (USD).		properties.currency

order_completed

Output KeyDescriptionOutput Key
type
Required		Type: String
Event type.		Conv
product
Required		Type: String
One of Ecommerce, Flight, Hotel, Package, Car		Default: Ecommerce
ids
Optional		Type: Comma-separated String
Viewed Product IDs.		product_id
orderId
Required		Type: String
Purchase order ID or confirmation ID.		properties.order_id
amount
Required		Type: Number
Total price amount.		N/A - Expression
currency
Required		Type: String
Currency code, i.e. (USD).		properties.currency

Required & Recommended Identifiers

These identifiers must be mapped to Clinch in order for successful user matching to occur. Without the required IDs, any events sent to Clinch will be rejected. For your convenience, required and recommended IDs are mapped as Global parameters to ensure they are added to every event

AttributeExampleSync Injector Required?
clinchClickId\_{ client_enc_id}
Required		?clinchClickId_abc12D=9K2bXp4s…Yes
clinch-sid
Highly Recommended		clinch-sid“:”5c299f0f-c409-4abc-bd10-4e17...Yes
hem
Highly Recommended		7c6a180b36896a0a8c02787eeafb0e4c52a24f8d44c98dbb5a3eac573e7b5eecNo

Additional Identifiers

These identifiers should be mapped to Clinch whenever possible to ensure the highest user match rates possible. If using these identifiers, they must be added as Global or Event Specific mappings.

AttributeDescriptionExample
didMobile resettable advertising ID, such as ADID, IDFA.D4F7112B-3F28-4C16-82C3-AB7FE10F6E2D

Additional Clinch Documentation

Clinch Data Enrichment

Updated 6 months ago