Not what you’re looking for?

Submit a Ticket
?

Partnerize Tag First Party Tracking Integration

__________________________________________________________________________________________________________________

This article will review:

  • What the Partnerize Tag is
  • What tracking features are included
  • The code that each brand should implement on their website
  • How to test the solution

__________________________________________________________________________________________________________________

Index

Overview

The Partnerize Tag is a client-side JavaScript tag that Brands and Partners may put on any of their website pages.  The tag will enable Brands or Partners to enable or disable any feature controlled within the Partnerize tag.  Features controlled within the Partnerize Tag compliment the platform.

To be used, the Partnerize Tag needs to be implemented by a Brand or Partner on their webpages.  Once implemented, users will be able to take advantage of available tag features.

This guide will cover how a brand can implement the Partnerize Tag onto their website, and use the First Party Tracking feature, which will enable a brand to:

  • Implement the Partnerize tag so that 1st party cookies are set whenever a partner link has been used to redirect a user to the brand website
  • Implement a Partnerize tracking pixel, to work in conjunction with the Partnerize tag First Party Tracking feature, whenever a user transacts via the brand website

Implementation Steps

Stage Description Stage Owner
Enable Partnerize Tag Network level feature to be enabled by Partnerize Integration team Partnerize
Create Partnerize tag and tracking pixel Partnerize tag and Conversion tracking pixel to be created and provided to the brand Partnerize
Implementation of Partnerize tag Implement the Partnerize tag on all pages of the brand website Brand
Implementation of Conversion tracking pixel Implement the Partnerize conversion tracking pixel of the brand confirmation pages Brand
Testing Perform testing of the tracking solution implemented Brand
Verify test results Review tests submitted to ensure that tracking solution has been implemented correctly Partnerize

Step 1 - Enable Partnerize Tag

The Partnerize tag is a network-level feature that must be enabled before use.  This step will be performed by the Partnerize Integration team as part of the configuration stage.

Step 2 - Create Partnerize tag and tracking pixel

The Partnerize Integrations team will provide the brand with:

  • The JavaScript code for the Partnerize tag, which will be unique for each brand.  This will also have the First Party Tracking feature enabled
  • The conversion tracking pixel to be implemented onto the confirmation page of the brand website

Step 3 - Implementation of Partnerize tag 

The brand will need to place the tag at the bottom of ALL pages of their site.  The following should help you determine which pages the tag should be present on:

  • Any page of which an inbound referral may land on
  • The checkout confirmation page, when you wish to submit your purchase information to Partnerize

The Partnerize Integrations team will provide a specific tag for the brand to implement, but the below is an example of the JavaScript code: 

<script src="https://pzapi-kg.com/b/XXXXX/YYYYY.js"></script>
  • The domain (pzapi-kg.com) may differ for your exact tag
  • XXXXX will be replaced by the brand ID
  • YYYYY will be replaced by a specific tag ID

The position of the tag is important. If you rely on any other scripts which are responsible for building the checkout confirmation pixel, you will need to ensure this is placed after that.

Once implemented, the First Party tracking feature will set a 1st party cookie on the user's web browser whenever a Partnerize tracking link has been clicked by an end user.  It will read a Partnerize click ID ('clickref') which is set in the query string of the website URL and set this clickref in the 1st party cookie.  Whenever a new click is initiated, a new clickref is generated and stored in the 1st party cookie.

Step 4 - Implementation of Conversion tracking pixel

Once the Partnerize tag has been implemented, the conversion tracking pixel also needs to be implemented on the confirmation pages for the brand and triggered after every successful transaction. Uppercase values highlighted must be dynamically populated.

<div data-partnerize="https://prf.hn/conversion/campaign:XXXXX/conversionref:CONVERSIONREF/country:COUNTRY/currency:CURRENCY/customertype:CUSTOMERTYPE/voucher:VOUCHER/[category:CATEGORY/sku:SKU/value:VALUE/quantity:QUANTITY][category:CATEGORY/sku:SKU/value:VALUE/quantity:QUANTITY]" style="display: none"></div>

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
  • 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.

__________________________________________________________________________________________________________________

NOTE:

  • The most recent Partnerize clickref stored in the 1st party cookie will be retrieved whenever the conversion tracking pixel is loaded from the confirmation page and will be appended to the pixel.  This provides a First Party Tracking feature for the brand.

__________________________________________________________________________________________________________________

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

<div data-partnerize="https://prf.hn/conversion/campaign:XXXXXX/conversionref:8516768/[category:DVD/sku:98735c/value:19.99/quantity:1]" style="display: none"></div>

Multiple Item Conversions

<div data-partnerize="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]" style="display: none"></div>

__________________________________________________________________________________________________________________

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.

__________________________________________________________________________________________________________________

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 a 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 

<div data-partnerize="https://prf.hn/conversion/campaign:XXXXXX/conversionref:8516768/[category:DVD/sku:98735c/value: 19.99/quantity:1/productname:ET/delivery:freeshipping/age:PG]" style="display: none"></div>
  • 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, i.e.;

  • Retail
  • Travel
  • Finance
  • Telecoms

Retail

Metadata parameter name

Description

Example

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

Metadata parameter name

Description

Example

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

Metadata parameter name

Description

Example

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

Metadata parameter name

Description

Example

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

 

Step 5 - 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

You should also test the implementation of the Partnerize tag:

  • View the page source to ensure that the Partnerize tag is shown
  • Click a test Partnerize link and check that the clickref is being stored in a 1st party cookie named '_pz_clickref'

Next Steps

  • Request a Partnerize tag and Conversion tracking pixel from the Partnerize Integration team.  Email integration.support@partnerize.com if you do not already have this.
  • Implement the Partnerize tag and Conversion tracking pixel onto the brand's live website.  Inform the Partnerize Integration team once this has been completed
  • 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 with regards to this document, please contact our onboarding specialists 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