Not what you’re looking for?

Submit a Ticket
?

Partnerize Standard Pixel Integration

__________________________________________________________________________________________________________________

This article will review:

  • An overview of the Partnerize standard pixel tracking solution
  • The code that each brand should implement on their website
  • How to test the solution

__________________________________________________________________________________________________________________

Index

Overview

Pixel tracking is the most common implementation of conversion tracking by brands and 3rd party tagging solutions. It matches conversions to clicks via a 3rd party cookie dropped by the Partnerize tracking servers at the point where the user clicks a Partnerize publisher click link. They are initially redirected to the Partnerize tracking API, then passed on to the relevant brand destination URL.

When the user converts on the brand site, a pixel call is rendered on the Web page, which connects the user to the Partnerize tracking API, and attempts to find a matching click if a Partnerize cookie resides within their browser. If a match exists the sale is awarded to the relevant publisher, and all transactional data captured via the tracking pixel is recorded. 

Implementation Steps

The below HTML code is implemented onto the confirmation page(s) within the <body> tags and triggered after every successful conversion. Highlighted values must be dynamically populated. 

<img src="https://prf.hn/conversion/campaign:{CAMPAIGNID}/conversionref:{ORDERID}/[category:{CAT}/sku:{SKU}/value:{VALUE}/quantity:{QTY}]" height="1" width="2"/> 

The conversion URI is populated with several parameters to record a valid conversion. These are key-value pairs, using a colon to separate the key-value pair, and a forward slash, to delimit each parameter:

Parameter name Description Example Required
campaign

Unique identifier assigned to the Partnerize campaign 

Please contact integration.support@partnerize.com if you do not have one

campaign:XXXXX Y
conversionref

Unique reference generated by brand for each conversion.  This is used for validation purposes. If no reference can be generated please omit this parameter and Partnerize can automatically create. 

Please note if Partnerize create a reference, it will be difficult to validate, as this value will be random.

conversionref:2345761 Y
country

The site country where the purchase occurred.

Must conform to the ISO 3166 letter country codes.

country:GB N
currency

The currency used for purchase.

Must conform to the ISO 4217 3-letter currency codes.

currency:GBP Y
customertype Defines whether a customer is a 1st time buyer or a repeat customer. Populated with ‘new’ or ‘existing’ customertype:new N
voucher The voucher/coupon code used at point of purchase voucher:10%OFF N

Basket Data Parameters 

To record individual items within a conversion, pass the details of each into a specific item container, which is held within square brackets []. The available parameters are listed below. Although not all parameters are required, it is advisable to return as much as possible to increase reporting granularity:

Parameter name Description Example Required

category 

The category of the item, which has a percentage or fixed value attributed to it

category:DVD 

Y

sku 

The item product code 

sku:98735c 

N

value 

The net item value 

This value is only compulsory if brand wishes to award % commission

value:19.99 

N

quantity 

The quantity of the item 

This must be a positive number and cannot be negative

quantity:1 

Y

__________________________________________________________________________________________________________________

NOTE:

  • No Personal Identifiable Information (PII) that a 3rd party could use to identify the end user should be passed into any of the tracking parameters (i.e. email address, home address, phone number, etc).

__________________________________________________________________________________________________________________

Single Item Conversion Example:

<img src="https://prf.hn/conversion/campaign:XXXXXX/conversionref:8516768/[category:DVD/sku:98735c/value:19.99/quantity:1]" height="2" width="2"/>

Multiple Item Conversion Example:

<img src="https://prf.hn/conversion/campaign:XXXXXX/conversionref:19970608/[category:bag/sku:3245ds/value:10.00/quantity:2][category:book/sku:2123bk/value:40.00/quantity:1]" height="2" width="2"/> 

__________________________________________________________________________________________________________________

NOTE:

  • The overall value of the sale is calculated from the value of each individual item
  • campaign:XXXXXX is a test campaign ID. Please contact integration.support@partnerize.com for your unique ID.

__________________________________________________________________________________________________________________

Voucher code tracking

Voucher codes can be applied to a conversion as a whole, or just an individual item (captured within the item container square brackets). This is to reflect the various types of voucher code, with some allowing a flat discount across all products, whereas some are specific to an item, such as 5% off a camera. 

This is captured within the voucher parameter in the conversion URL. 

Voucher code at Conversion Level Example:

<img src="https://prf.hn/conversion/campaign:XXXXXX/conversionref:19970608/voucher:tenpercent/[category:bag/sku:3245ds/value:10.00/quantity:2][category:book/sku:2123bk/value:40.00/quantity:1]" height="2" width="2"/> 

Voucher code at Conversion Item Level Example:

<img src="https://prf.hn/conversion/campaign:XXXXXX/conversionref:19970608/[category:bag/sku:3245ds/value:10.00/quantity:2/voucher:cheapbags][category:book/sku:2123bk/value:40.00/quantity:1]" height="2" width="2"/> 

__________________________________________________________________________________________________________________

NOTE:

  • The discount of the voucher must be reflected in the value amount for all items to which it relates. This ensures that the commission calculated from the conversion is taken from the fully discounted total, not the pre-voucher amount. 
  • If this is not technically possible, it can be counteracted or complimented by specifying a specific commission rate based on the use of a voucher code via the Partnerize API. 
  • If no voucher code is used the parameter can simply be left empty.

__________________________________________________________________________________________________________________

Customer type tracking

It is possible to report and allocate specific commission levels, based on the type of customer who was responsible for the conversion. This is achieved via the customertype parameter, and is always passed at the conversion level (outside of item container square brackets). 

New Customer Example:

<img src="https://prf.hn/conversion/campaign:XXXXXX/conversionref:19970608/voucher:tenpercent/customertype:new/[category:bag/sku:3245ds/value:10.00/quantity:2][category:book/sku:2123bk/val ue:40.00/quantity:1]" height="2" width="2"/> 

Existing Customer Example:

<img src="https://prf.hn/conversion/campaign:XXXXXX/conversionref:13817d1/customertype:existing/[category:bag/sku:3245ds/value:10.00/quantity:2]" height="2" width="2"/> 

__________________________________________________________________________________________________________________

NOTE:

  • “customertype” values can only be ‘new’ or ‘existing’ 
  • How a customer is defined as ‘new’ or ‘existing’ is based on the brand's own business rules.

__________________________________________________________________________________________________________________

Currency tracking

For brands that allow purchases to be made in multiple currencies, it is possible to record the actual currency used during sale. This is achieved via the currency parameter. 

EUR Currency Example:

<img src="https://prf.hn/conversion/campaign:XXXXXX/conversionref:19970608/voucher:tenpercent/customertype:new/currency:EUR/[category:bag/sku:3245ds/value:10.00/quantity:2][category:book/s ku:2123bk/value:40.00/quantity:1]" height="2" width="2"/> 

__________________________________________________________________________________________________________________

NOTE:

  • currency conforms to the ISO 4217 three letter currency codes(eg. GBP, USD) 
  • If this parameter is not supplied the currency will use the campaign default as specified in Admin -> campaign within the Partnerize console 
  • Please note the currency parameter is used for reporting purposes only and will not be used to apply any real time currency conversions so please ensure the purchase amounts are correct. 

__________________________________________________________________________________________________________________

Metadata Tracking

Partnerize offers a flexible and robust pixel, allowing brands to record additional sale information outside of the standard predefined tracking parameters. Within the Partnerize conversion tag an brand can include as much metadata as possible. 

This flexibility provides brands a greater insight and granular level of reporting for sale optimization. 

The meta parameter name can be defined by the brand but must follow the syntax of parameter_name:value delimited by the ‘/’ 

Metadata Example 

<img src="https://prf.hn/conversion/campaign:XXXXXX/conversionref:8516768/[category:DVD/sku:98735c/value: 19.99/quantity:1/productname:ET/delivery:freeshipping/age:PG]" height="2" width="2"/> 

__________________________________________________________________________________________________________________

NOTE:

  • Any meta parameters must be contained within the item blocks[ ]
  • Please avoid using the parameter name of ‘destination’ 

__________________________________________________________________________________________________________________

Vertical specific metadata parameters
Below are some examples of commonly used meta parameters for different verticals e.g.

  • Retail
  • Travel
  • Finance
  • Telecoms

Retail:

Meta Parameter Name Description Example Value

product_name

Populated with the product name for the item purchased

product_name:Nike Air Max 270

product_brand

Populated with the product brand for the item purchased

product_brand:Nike

product_type

Populated with the product type for the item purchased

product_type:Trainers

product_size

Populated with the size for the item purchased

product_size:10

product_colour

Populated with the colour for the item purchased

product_colour:Black

product_gender

Populated with the product gender for the item purchased

product_gender:Men

 

Travel:

Meta Parameter Name Description Example Value

check_in_date

Populated with the check in date for the booking

check_in_date:2019-09-17

check_out_date

Populated with the check out date for the booking

check_out_date:2019-09-20

hotel_id

Populated with the hotel ID for the booking

hotel_id:55871

hotel_location

Populated with the hotel location

hotel_location:London

refundable

Populated with the cancellation status for the booking

refundable:Yes

number_of_guests

Populated with the number of guests for the booking

number_of_guests:2

number_of_nights

Populated with the number of nights for the booking

number_of_nights:1

origin

Populated with the flight origin (i.e. airport code)

origin:NCL

dest

Populated with the flight destination (i.e. airport code)

dest:AMS

passengers

Populated with the number of passengers

passengers:2

haul

Populated with the flight haul (i.e. long haul / short haul)

haul:Short+Haul

return

Populated based on if the booking is a one way or return journey

return:Yes

flight_class

Populated with the flight class for the booking (i.e. Economy / Business Class / First Class)

flight_class:Economy

net_value

Populated with the net booking value


NOTE: This is on the assumption that the VALUE parameter is populated with GROSS booking value.  These parameters are interchangable (i.e. VALUE can be populated with NET booking value, and GROSS can the be tracked as an additional meta parameter instead)

net_value:150.00

 

Finance:

Meta Parameter Name Description Example Value

cover_type

Populated with the cover type for the policy

cover_type:Buildings & Contents

policy_start_date

Populated with the policy start date

policy_start_date:2019-09-17

policy_end_date

Populated with the policy end date

policy_end_date:2020-09-17

monthly_payment

Populated with the monthly payment amount

monthly_payment:21.57

application_status

Populated with the application status, where a real time decision is returned

application_status:Approved

product_name

Populated with the product that was applied for

product_name:Balance Transfer

credit_limit

Populated with the credit limit provided

credit_limit:5000

loan_amount

Populated with the loan amount

loan_amount:10000

loan_term

Populated with the loan term

loan_term:15

 

Telecoms:

Meta Parameter Name Description Example Value

contract_length

Populated with the contract length for the order

contract_length:24m

download_limit

Populated with the download limit

download_limit:Unlimited

speed

Populated with the broadband speed

speed:100Mbps

activation_fee

Populated with the activation fee for the order

activation_fee:30.00

manufacturer

Populated with the manufacturer of the handset purchased

manufacturer:Samsung

handset

Populated with the handset purchased

handset:Galaxy+S10

minutes

Populated with the number of available minutes for the contract

minutes:Unlimited

texts

Populated with the number of available texts for the contract

texts:Unlimited

data

Populated with the amount of available data for the contract

data:10Mb

operating_system

Populated with the operating system

operating_system:Android

add_ons

Populated with any add ons. add_ons:5mb_data

Testing

Once the tags are deployed, they should be tested by submitting a test transaction via the brand’s live website.  A non session test should be performed, which simulates a returning customer who originally followed a partner link but purchased at a later date. Providing the sale is made within the cookie period of the brand, the transaction should track successfully.  Full testing instructions can be found here:

https://help.phgsupport.com/hc/en-us/articles/360019824018-Testing-Tracking-Solutions-FAQs

NEXT STEPS

  • Request a campaign_id from the Partnerize Integration team. Email integration.support@partnerize.com  if you do not already have this.
  • Implement the relevant tracking pixel as described in the above guidance.
  • Perform testing using the above instructions - Transactions will need to be submitted via the brand’s live website, so that the implementation can be fully tested.  

QUESTIONS 

If you have any technical questions regarding this document please get in touch with our Integration team at integration.support@partnerize.com   

 

Was this article helpful? 0 out of 0 found this helpful

Didn't get the answer you need?

Get in Touch