Awin Conversions Connector Setup Guide | Server-Side Connectors

Awin is an affiliate marketing platform for businesses of all sizes to collaborate with publishers and advertisers to track affiliate program performance metrics. Features include a network of affiliate partners, click tracing and tracking, advertiser directory, reports and analytics, and more. The integration supports conversion and product-level conversion events.

API Information

This connector uses the following vendor API:

API Name: Awin API
API Endpoint: https://www.awin1.com
Documentation: Awin API
Authentication Type: OAuth2.0

How it works

Awin recommends a server-side implementation to provide signal resilience. As such, the connector doesn’t replace the client-side pixel tag, but complements it. This pixel is used to attribute the conversions that result from a referral link that contains an awc query string parameter to identify the source of the traffic. Using Tealium extensions or having the client persisting this parameter then sending it from the server-side guarantees that the purchase is correctly credited to the correct commission group.

Because Awin no longer supports the use of pixel-only implementations due to various browser updates, this connector lets you to use the Awin S2S API implementation as a fallback.

Configuration

Go 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:

Token
Required. This token is linked to your personal user account. For more information on creating your token, see AWIN: AWAuthentication and Authorization.
Merchant (Advertiser ID)
Applicable Awin advertiser ID. Contact your Awin account manager for support.

Click Done when you are finished configuring the connector.

Deduplication

If you are working with multiple marketing channels and/or networks, it is necessary to perform de-duplication so that commission is not paid out to several traffic sources for the same conversion. For more information, please see below regarding the Channel Parameter and AWIN: De-duplication.

Channel parameter

Awin strongly advises all clients to use the Channel Parameter to instruct our system how to process each conversion based on the source of the traffic.

Populating that parameter with the winning channel code allows Tealium to handle the request in four ways:

Do not process
Process if any Awin cookie is present
Only process if an Awin click cookie is present
Only process if an Awin post-view cookie is present

Actions

Action Name	AudienceStream	EventStream
Send Conversion	✓	✓
Product Level Conversion	✓	✓

Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu.

The following section describes how to set up parameters and options for each action.

Send Conversion

Server to Server Tracking is now a mandatory element of tracking. The requirement is that conversion data is sent (via a HTTPS request through the Tealium Connector) directly from the Tealium Customer Data Hub to Awin’s servers.

Parameters

Parameter	Description
Total Amount	(Required) The order subtotal amount after any relevant discounts are applied, but prior to any additional fees such as taxes, delivery charges, or relevant service charges. The value must be a float data type, no thousand separator is allowed, and the decimal place must be a standard dot (`.`) character.
Order Reference	(Required) The unique booking or order ID.
Merchant (Advertiser ID) (override)	The advertiser program ID.
Commission Group Code	(Recommended) The code or codes for the commission groups you want to attribute the transaction to. This parameter can be a string for a single group or an array for multiple groups. Accepted characters are upper-case alphanumerics, underscores, and hyphens. If this parameter is not populated, Awin will fall back to the default commission group.
Commission Group Amount	The commission amounts that you want to assign to each commission group. This parameter can be a string for a single group or an array for multiple groups. Array values must appear in the same order as the commission group array. If not mapped, the default value is the mapped total amount.
Channel	The channel name of the last click referrer. Always use aw for Awin, which is the default value. This value must be 20 alphanumeric characters or less. We strongly suggest that you include this parameter so the Awin system knows how to process each conversion based on the source of the traffic. Example values may include: `aw` (which should always be used for Awin), `display`, or `ppc`.
AWC parameter	This value is appended to the landing page URL by Awin to identify the source of the click. You must supply a value for either the AWC parameter or the Voucher Code. The `awc` value is a parameter that is appended to the landing page URL by Awin to identify the source of the click. You must configure your site to record the `awc` value when the end user lands on the site, using a server-side scripting language. This value will be used to populate the `cks` parameter on conversion. This function needs to be called on every page. If you are capturing the awc value with a cookie, follow these guidelines: The cookie must be set the in HTTP response header and not in a client-side script for example, a cookie set in PHP would be fine. The cookie should set the cookie with the HTTP Only flag The cookie should be set with the secure flag
Voucher Code	A URL-encoded voucher code for the transaction. You must supply a value for either the AWC parameter or the Voucher Code.
Currency Code	The ISO currency code of the currency that was used in the transaction, for example GBP or USD. Note: This parameter is highly recommended to maintain accurate tracking.
Custom Parameters	The input data for single or multiple custom tracking parameters.
Test Mode	Incoming tracking requests will not be processed for the purposes of testing.

Product Level Conversion

Product Level Tracking enables an advertiser to produce much more in-depth reporting where the performance of individual products can easily be measured.

Parameters

Parameter	Description
Total Amount	(Required) The order subtotal amount after any relevant discounts are applied, but prior to any additional fees such as taxes, delivery charges, or relevant service charges. The value must be a float data type, no thousand separator is allowed, and the decimal place must be a standard dot (`.`) character.
Order Reference	(Required) The unique booking or order ID.
Merchant (Advertiser ID) (override)	The advertiser program ID.
Commission Group Code	(Recommended) The code or codes for the commission groups you want to attribute the transaction to. This parameter can be a string for a single group or an array for multiple groups. Accepted characters are upper-case alphanumerics, underscores, and hyphens. If this parameter is not populated, Awin will fall back to the default commission group.
Commission Group Amount	The commission amounts that you want to assign to each commission group. This parameter can be a string for a single group or an array for multiple groups. Array values must appear in the same order as the commission group array. If not mapped, the default value is the mapped total amount.
Channel	The channel name of the last click referrer. Always use `aw` for Awin, which is the default value. This value must be 20 alphanumeric characters or less. We strongly suggest that you include this parameter so the Awin system knows how to process each conversion based on the source of the traffic. Example values may include: `aw` (which should always be used for Awin), `display`, or `ppc`.
AWC parameter	This value is appended to the landing page URL by Awin to identify the source of the click. You must supply a value for either the AWC parameter or the Voucher Code. If you are capturing the awc value with a cookie, follow these guidelines: The cookie must be set the in HTTP response header and not in a client-side script for example, a cookie set in PHP would be fine. The cookie should set the cookie with the HTTP Only flag The cookie should be set with the secure flag
Voucher Code	A URL-encoded voucher code for the transaction. You must supply a value for either the AWC parameter or the Voucher Code.
Currency Code	(Recommended) The ISO currency code of the currency that was used in the transaction, for example, GBP or USD.
Product Name	(Required) An array of product names in the transaction.
Product ID	(Required) An array of unique product IDs in the transaction.
Product Quantity	(Required) An array of the quantity of each of the products in the transaction.
Product SKU	(Required) An array of the SKU of each of the products in the transaction.
Product Item Price	(Required) An array of the prices for a single quantity of each of the products in the transaction. This single unit price must reflect the price after any relevant discount is applied, but prior to any taxes or additional charges are applied. The value must be a float, no thousand separator is allowed, and the decimal place must to be a standard dot character.
Product Category	(Required) An array of each product’s category in the transaction.
Custom Parameters	The input data for single or multiple custom tracking parameters.
Test Mode	Incoming tracking requests will not be processed for the purposes of testing.