Publisher Tracking Guide

Introduction

Optimise Tracking URLs are broken down into 2 component parts: Domain - our different networks use different domains so please check this carefully if creating links manually. QueryString parameters - our tracking requires a minimum of 2 QueryString parameters but there are many optional values available for tracking additional metrics.

Domains

Optimise uses different domains for its different affiliate networks. Please check the table below:

NetworkClick DomainTracking DomainCountries/Regions
Optimise Australiaclk.omgt2.comtrack.omguk.comAustralia
Optimise Brazilclk.omgt6.comtrack.omguk.comBrazil
Optimise Indiaclk.omgt5.comtrack.in.omgpm.comIndia
Optimise PL-track.omgpl.comPoland
Optimise SE ASIAclk.omgt3.comtrack.omguk.comHong Kong, Indonesia, Malaysia, Phillipines, Singapore,Taiwan, Thailand, Vietnamn
Optimise UKclk.omgt1.comtrack.omguk.comUnited Kingdom

Notes: Each network also has its own Click Domain - Please note that these "Click Domains" can change. Any existing "Click Domain" will continue to function even if it is changed. Click domains can be used with HTTP or HTTPS.

SubID (UID)

Add a SubID (UID)

You can add SubID's (UID - Unique Identifier) to Optimise tracking links as follows (note the below URL is an example only) :

https://clk.omgt1.com/?AID=XXX&PID=XXX&UID={UID}&UID2={UID2}&UID3={UID3}&UID4={UID4)&UID5={UID5}

There are 5 optional UID values available which can be viewed in the Transactions Overview Report:

Field NameField TypeField Size
UIDString50
UID2String50
UID3String50
UID4String50
UID5String250
important

Before using UID,  ensure that a programme supports UID by checking the "All Campaigns" page in your affiliate login.

Conversion Reporting

To retrieve Conversions with an associated UID/SubID access the COnversions Report in your Publisher login.

You can access the Conversions Report via the API Optimise Network API

Deeplinks

By default an Optimise tracking link will typically redirect to the advertisers homepage or a generic product/category page. However, if you wish to “deeplink” to a different page within the merchants website then follow the instructions for constructing a Deeplink.

Deeplinking directly to the content assists the user in getting to the information they want more quickly which an increase conversion rates and earnings.

important

Before constructing a deeplink you must ensure that a programme has been “Deep linking enabled” in your affiliate login under the Technical section of the programme details as per the below:

Deeplink enabled

When to use a deeplink

  1. To link to a product specific page on a shopping site
  2. To link directly to a hotel's details on a travel website

Constructing a Deeplink

A deeplink can be constructed by adding the &r= parameter to an Optimise tracking URL as follows:

https://clk.omgt1.com/?AID=1234&PID=1234&r=http://www.website.com

URL Encoding

A deeplink URL should be correctly URL encoded to ensure compatibility with all browsers. For example the following deeplink would be constructed as follows with the correct URL Encoding:

https://www.website.com/?Param1=aValue&Param2=anotherValue

URL encoded would be:

https%3A%2F%2Fwww.website.com%2F%3FParam1%3DaValue%26Param2%3DanotherValue

An Optimise tracking URL with deeplink would therefore be as follows:

https://clk.omgt1.com/?AID=1234&PID=1234&r=http%3A%2F%2Fwww.website.com%2F%3FParam1%3DaValue%26Param2%3DanotherValue
tip

Be aware that whilst some browsers will accept an unencoded deeplink it is advised that all deeplinks are URL encoded to ensure backward compatibility with older browsers and to avoid any complications with any additional Advertiser' tracking.

A useful URL encoder tool can be found here

Browser Extension

The Google Chrome Optimise Deeplinking Extension can be downloaded from the following URL: https://chrome.google.com/webstore/detail/omg-deeplink-generator/boegkkdocefaaaiaapokfkiggnijgkak

With this extension you can browse to any page on the website of any Optimise Advertiser on which you have an active programme.

Installing Extension

Once installed, the extension is activated by clicking on the button in the Extension Toolbar:

IMG OF EXTENSION BUTTON

You will need to configure the extension with 3 properties that can be found in your Optimise Publisher account:

  1. Locate your API credentials in your login by going to My Details > Update Account Details.
  2. Click the API Keys tab and copy & paste your Affiliate ID, API Key & Private key into the relevant fields.
  3. Click Add.

Once configured, go to the Advertiser site where you want to create a deeplink and activate the Optimise Deeplink Extension:

Choose the relevant Campaign and Website, add a UID (if required) and the correct deeplink will be created.

Deprecated deeplinks

Optimise has deprecated our old deeplinking parameter &redirect= in place of a new parameter &r=. &r= offers simpler integration and ongoing management of deeplinks and affiliates should migrate away from &redirect= as soon as possible.

Parallel Tracking

Optimise provides support for Google Adwords Parallel Tracking. By associating Google's Click ID value gclid with the Optimise Click ID values this allows for attribution of conversion.

To implement this, please follow this guidance:

  • Ensure that the gclid macro is configured on the Final URL in an Ad (landing page)
  • Add the following GCLID parameter and associated macro in the Tracking Template of the Ad:
https://track.omguk.com/?AID=XXXX&PID=XXXX&GCLID={gclid}

Google Adwords - Parallel Tracking

Website Tracking

It is possible for Publishers to record the website that a click or conversion originated from. This can be achieved by adding WID (WebsiteID) to the Tracking URL when selecting it the Dashboard.

IMG GOES HERE

Placements

In some instances an Advertiser may provide multiple placement URLs with different landing pages. These can be found on the Campaign Detail page as per below:

IMG OF PLACEMENTS

Mobile Device IDs

Where available we recommend passing Mobile Device IDs to ensure the most effective tracking.

https://clk.omgt1.com/?AID=1234&PID=1234&GoogleID={GoogleAID}&IFA={IFA}

Click URL Parameters

The following optional parameters or macros can be included on a click URL:

ParameterData TypeDescription
UIDStringUniqueID/SubID – read more here
IIDIntegerItemID – the Optimise ItemID from an Optimise Product Feed
WIDIntegerWebsiteID – the ID of your website as registered in the Optimise system
CRIDIntegerCreativeID – the ID of a creative AdContainer
IFVStringiOS IFV
IFAStringiOS IFA
AndroidIDStringAndroid ID
GoogleIDStringGoogle Advertiser ID

Adding Postback/Callback URLs

Global Postback URL

If you have a permanent Global Postback URL that you would like to implement permanently across all of your campaigns please speak to your account manager about this.

Adding to a Campaign

For certain types of campaigns you can add a Postback URL by going to the Campaign Details screen and selecting the Key Information tab:

Add a postback

Enter your postback along with any Supported Macros. If this is not available please speak to your account manager to have Postback/Callback URLs added to your campaign.

Example Postback URL

https://www.callbackurl.com/?SaleID={SALEREF}VoucherUsed={VCODE}&SaleValue={STATUS}&SubID1={UID}&SubID2={UID2}&SubID3={UID3}&SubID4={UID4}&SubID5={UID5}&ex1={EX1}&ex1={EX1}&ex2={EX2}&ex3={EX3}&ex4={EX4}&ex5={EX5}

Postback URL Macros

MacroDescription
{CONVERSIONID}The Optimise ConversionId reference number
{SALEREF}The Sale reference number
{VCODE}The Voucher Code used in the transaction
{STATUS}The Transaction Value
{UDATE}A UNIX date value generated at the time of the postback event
{UID}Unique ID/SubID used on click
{UID2}Unique ID 2/SubID 2 used on click
{UID3}Unique ID 3/SubID 3 used on click
{UID4}Unique ID 4/SubID 4 used on click
{UID5Unique ID 5/SubID 5 used on click
{EX1}Extended Data 1 field. A unique date value - some merchants may make extended data available to their affiliates
{EX2}Extended Data 2 field. A unique date value - some merchants may make extended data available to their affiliates
{EX3}Extended Data 3 field. A unique date value - some merchants may make extended data available to their affiliates
{EX4}Extended Data 4 field. A unique date value - some merchants may make extended data available to their affiliates
{EX5}Extended Data 5 field. A unique date value - some merchants may make extended data available to their affiliates
{EX6}Extended Data 6 field. A unique date value - some merchants may make extended data available to their affiliates
{EX7}Extended Data 7 field. A unique date value - some merchants may make extended data available to their affiliates
{EX8}Extended Data 8 field. A unique date value - some merchants may make extended data available to their affiliates
{EX9}Extended Data 9 field. A unique date value - some merchants may make extended data available to their affiliates
{EX10}Extended Data 10 field. A unique date value - some merchants may make extended data available to their affiliates
{EX11}Extended Data 11 field. A unique date value - some merchants may make extended data available to their affiliates
{COMMISSION}Affiliate Commission. IMPORTANT: This is provided for reporting purposes only - validation status and commission may change between the time a transaction is tracked and the invoice date.
{ANDROIDID}The device Android ID (mobile campaigns only)
{GOOGLEID}The Google Advertising ID (mobile campaigns only)
{IFV}iOS Vendor identifier (mobile campaigns only)
{IFA}iOS Advertising identifier (mobile campaigns only)
{IPADDRESS}IP Address of the Device (mobile campaigns only)
{CURRENCY}The currency of the transaction (mobile campaigns only)
{DEVICENAME}The model number/name of the device (mobile campaigns only)
{DEVICEOSVERSION}The Operating System installed on the device (mobile campaigns only)
{DEVICEBUILDNUMBER}The Build Number of the device (mobile campaigns only)
{PACKAGENAME}The App Package Name (mobile campaigns only)
{APPVERSION}The build number version of the App (mobile campaigns only)