Clinch Connector Setup Guide
This article describes how to set up the Clinch connector.
API Information
This connector uses the following vendor API:
- API Name: Clinch API
- API Version: 1.0
- API Endpoint:
https://trkweb.clinch.co/trk
Configuration
Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see About Connectors.
After adding the connector, configure the following settings:
- Client ID
- Required. The Client ID.
- Client-encoded ID
- Required. The Client-encoded ID.
- Data Source ID
- Required. The Data Source ID.
Actions
Action Name | AudienceStream | EventStream |
---|---|---|
Sent Event | ✗ | ✓ |
Enter a name for the action and select the action type from the drop-down menu.
The following section describes how to set up parameters and options for each action.
Sent Event
Technical Parameters
Parameter | Description |
---|---|
referrer |
The page URL where the event originated from. |
timestamp |
The event time stamp in UTC. |
tcf |
The GDPR consent string using IAB. |
user_ip |
The user IP address. |
user_agent |
The user agent. |
Event Type | Select the event type. |
Event Parameters
Parameter | Description |
---|---|
type |
The event secondary type (usually provided in conversion events). |
product |
The product type (vertical). In case the event contains products or categories to match from product feeds. For example, Ecommerce , Flight , Hotel , Package Car . |
Identity Parameters
Parameter | Description |
---|---|
clinch-sid |
The Clinch cookie ID, as given in cookie sync with Clinch, or read from the website first-party cookie clinch-sid . |
clinchClickId |
The value expected for clinchClickId_{client_enc_id} is the 1P cookie value for the cookie clinchId_{client_enc_id} . |
Email Address | (Already SHA256 hashed) Provide an email address which has been already SHA256 hashed. |
Email Address | (Apply SHA256 hash) Provide a plain text email address and the connector will whitespace trim, lowercase, and hash this value using SHA256 hash. |
atsEnvelop |
The Liveramp Authenticated Traffic Solution (ATS) envelope. |
uid2_0 |
The UID2.0 identifier. |
did |
The mobile resettable advertising ID, such as ADID and IDFA. |
Content (Ecommerce)
Parameter | Description |
---|---|
ids |
The viewed Product IDs (should match product IDs in product feed). |
category |
The product category (should match the category in product feed). |
recommended |
The recommended Product IDs (should match product IDs in product feed). These are product IDs that the website or vendor recommendation engine may suggest to the user, as opposed to products that the user engaged with. |
term |
The search term (usually in search event). |
Content (Travel)
Parameter | Description |
---|---|
from |
The origin city or airport data code (should match the product feed). |
to |
The destination city or airport data code (should match the product feed). |
depart |
The departure date in ISO 8601 format. For example, 2023-09-21 . |
return |
The return date in ISO 8601 format. For example, 2023-09-21 . |
city |
The city code for hotel products (must match the city parameter in hotel feed). |
ids |
The hotel IDs. |
Purchase Event Parameters
Parameter | Description |
---|---|
orderId |
The purchase order ID or confirmation ID. |
amount |
The total price amount. |
currency |
The currency code. |
Privacy & Consent
Parameter | Description |
---|---|
tcf_string |
The GDPR TCF string. |
ccpa_string |
The CCPA privacy string. This is replaced with Global Privacy Platform (GPP). Use gpp_string instead. |
gpp_string |
The GPP consent string. |
Other | User tags, such as audience segments or user attributes. These tags are entered into user profile and can be used during ad decision. |
This page was last updated: August 21, 2024