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 that brands implement within their website pages.  Once implemented, brands can take full advantage of features controlled via the Partnerize tag that compliment the Partnerize platform.

This guide outlines how a brand can implement the Partnerize Tag and utilise the First Party Tracking feature. This consists of the following : 

  1. Implement landing page tag  : This captures and stores a unique Partnerize ID ("clickref")  in 1st party storage whenever a user is referred by Partnerize. 
  2. Implement conversion page tag :  When a user converts at the checkout page, the brand will return all transactional information. The Partnerize ID ("clickref") is automatically injected within the conversion event and the partner is rewarded. This by-passes the browser's need to access any 3rd party cookies.

__________________________________________________________________________________________________________________

Implementation Overview

Stage Description Stage Owner
1. Enable Partnerize Tag Network level feature to be enabled by Partnerize Integration team Partnerize
2. Create Partnerize Tags Landing page and conversion tracking tag created and provided to brand Partnerize
2b. Auto append clickref Team will ensure a unique click identifier (clickref) is passed into each destination page, which is required for the feature to operate Partnerize
3. Implementation of landing page tag Implement the landing page tag on all pages of the brand website Brand
4. Implementation of conversion tracking tag  Implement the conversion tracking tag on the brand confirmation pages Brand
5. Testing Perform testing of the tracking solution implemented Brand
6. Verify test results Review tests submitted to ensure that tracking solution has been implemented correctly Partnerize

 

__________________________________________________________________________________________________________________

Implementation Steps

Step 1 - Enable Partnerize Tag (Partnerize)

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 Tags (Partnerize)

The Partnerize Integrations team will provide the brand with:

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

__________________________________________________________________________________________________________________

Step 2b - Auto append "clickref" to all traffic (Partnerize)

All Partnerize referred traffic to brand's site will include a unique ID ("clickref") within the query string.

  • E.g) https://www.brand-site.com?clickref=ABC1234

The First Party tracking feature will set this Partnerize click ID ("clickref") in a 1st party storage.  Whenever a new click is initiated, a new "clickref" is generated and updated.

  • E.g) https://www.brand-site.com?clickref=DEF456

Upon checkout, the most recent "clickref" present will be used to reward "last click" wins.  

__________________________________________________________________________________________________________________

Step 3 - Implementation of Partnerize tag (Brand)

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 (NOTE: This is in addition to the conversion tracking tag)

 

Example Partnerize landing page tag

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 other scripts responsible for populating the checkout conversion tag, you will need to ensure the tag shown here is placed after that.

__________________________________________________________________________________________________________________

Step 4 - Implementation of Conversion tracking tag (Brand)

In addition to the landing page tag, the conversion tacking tag is also implemented onto the confirmation pages and triggered after every successful transaction. 

 

Example conversion tag (each brand will be provided their specific) : 

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>

 

Explanation of parameters

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 

This will be supplied by the Integration team

campaign:XXXXX Y
conversionref

Unique order reference generated by brand for each conversion.

This is used for validation purposes

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:discount10 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 will be retrieved whenever the conversion tracking tag is loaded from the confirmation page and automatically injected to the tag.  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 top level category of the item category:SHOES 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:

  • "value" is multiplied by "quantity" to calculate the total basket cost. 
    • If brand awards % based commission, this total cost is used
    • Ensure "value" is the individual item value 
  • 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).

__________________________________________________________________________________________________________________

Example populated conversion tags

Single Item Conversion 

Example:

<div data-partnerize="https://prf.hn/conversion/campaign:XXXXXX/conversionref:8516768/country:GB/currency:GBP/customertype:new/voucher:Discount10/[category:shoes/sku:98735c/value:19.99/quantity:1]" style="display: none"></div>

Multiple Item Conversions

<<div data-partnerize="https://prf.hn/conversion/campaign:XXXXXX/conversionref:5787898/country:US/currency:USD/customertype:existing/voucher:/[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 the team for live ID via  integration.support@partnerize.com 

__________________________________________________________________________________________________________________

Metadata Tracking

Partnerize offers a flexible and robust reporting, 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 Examples

For examples of vertical specific tracking parameters please see https://help.phgsupport.com/hc/en-us/articles/4410042606225-Vertical-Specific-Tracking-Parameters 

__________________________________________________________________________________________________________________

Step 5 - Testing (Brand)

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 the "clickref" is stored browser local storage named '_pz_clickref'

__________________________________________________________________________________________________________________

Step 6 - Verify test results (Partnerize)

Once tested, the Partnerize team will conduct internal checks to ensure tracking is working before giving sign off. This includes reviewing  :  

  • Transactions are recorded in the Partnerize dashboard
  • All tracking parameters are populated correctly, and the conversion call is correctly formatted
  • Tracking has been implemented on live confirmation pages and not staging environment
  • "clickref" parameter is populated by the last contributing "clickref" value 

__________________________________________________________________________________________________________________

Next Steps

  • Request a Partnerize tag and Conversion tracking tag from the Partnerize Integration team.  Email integration.support@partnerize.com if you do not already have this.
  • Implement the Partnerize tag and Conversion tracking tag 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