Advertiser Integration Instructions When Using Direct Linking

These instructions are specific to the integration of the OneQor Digital tracking code to an active WooCommerce installation. For implementation on Shopify or other platforms, please contact Octavius Moore and/or Marcus Campbell (emails at the end of documentation).

Retrieve Affiliate Code

To set up your affiliate tracking, you must first have the correct code to implement within your site. If you have not already received your affiliate tracking codes, please request this from Octavius Moore. Do note, there are three different affiliate tracking codes.

  • Click Tracking – Click tracking must be configured to ensure that it is placed on each possible landing page or entry point to the site from an affiliate. For many brands, this may be either product-specific or category-specific landing pages, but this can also be the homepage. Regardless of where this script is placed, click tracking will only fire if an offer ID and affiliate ID are present in the originating URL.
  • Conversion Tracking – Conversion tracking must be placed on the page where the desired conversion event occurs. For most brands using WooCommerce, this would be on the final thank-you or order confirmation page. If this script misfires, it will skew conversion and reporting metrics within the system.
  • Impression Tracking – Impression tracking can be set up if a click is not present, however, impression tracking will not take precedence over click tracking. If an impression is fired without a click being triggered on the page, a click event may not be registered. This will not allow view-thru attribution. View-Thru Attribution must be separately enabled. Please contact Octavius Moore if view-thru attribution is required.

Implement Tracking Code

Once you have the affiliate tracking code, ensure that click tracking is properly implemented on the provided landing pages (typically your base destination URL) and any other pages that will serve as landing pages in the campaign.

Click Tracking will usually depend on dynamic parameters being inserted into the tracking script. Thus no modification is necessary once the script is placed on the appropriate page unless other custom parameters need to be passed into the system.

An example of the click tracking script can be found following the next paragraph. This script will pull parameters directly from the tracking link or URL.

A tracking link of https://yourdomain.com/?offid={your_offer_ID}&affid=1 should correctly fire the below script if implemented on the page which the user entered (in this case the homepage). The correct offer id must be in place of {your_offer_id} with the appropriate active offer in the dashboard. This should be presented as a simple integer such as “6” or “34”.

<script type="text/javascript" src="https://{your-tracking-domain}/scripts/sdk/everflow.js"></script>
 
<script type="text/javascript">
EF.click({
    offer_id: EF.urlParameter('oid'),
    affiliate_id: EF.urlParameter('affid'),
    sub1: EF.urlParameter('sub1'),
    sub2: EF.urlParameter('sub2'),
    sub3: EF.urlParameter('sub3'),
    sub4: EF.urlParameter('sub4'),
    sub5: EF.urlParameter('sub5'),
    uid: EF.urlParameter('uid'),
});
</script>

Note, only offer_id and affiliate_id are need in order to trigger the tracking script. The absence of either or will result in an invalid click.

Note, if deep linking is enabled, affiliates will be able to direct traffic to any page on the site. If deep linking is enabled, we highly recommend that the click tracking be implemented globally in a common header or footer.

Install Conversion Pixel

Once you have the conversion tracking code, ensure that conversion tracking is properly implemented on the target page for the conversion event. With most e-commerce brands this should be the thank-you, checkout confirmation or order confirmation page.  

An example conversion tracking script look as follows.

<script type="text/javascript" src="https://{your-tracking-domain})/scripts/sdk/everflow.js"></script>
 
<script type="text/javascript">
EF.conversion({
       offer_id: [Your Offers ID], // Required(only if advertiser_id is not present). 
       advertiser_id: [Your Advertisers ID], //Required(only if offer_id is not present). 
       advid: [Your Advertisers ID], //Required(only if offer_id is not present). 
       aid: [Your Advertisers ID], //Required(only if offer_id is not present). 
 
       transaction_id: EF.urlParameter('tid'), // Optional. Returned from partners using a tracking link redirect.
 
       amount: 0, // Purchase amount used for RPS offers - WooCommerce dynamically generates this value, which must then be passed here. To reduce monthly reconciliation, subtotal values after discounts and coupons are applied should be passed here. 
 
       coupon_code: '', // Optional. Coupon code used - your Shopping Cart may be able to generate this dynamically.
 
       event_id: [Your Event's ID], // this is required if you are placing this for an offer level event . 
       
adv_event_id: [Your advertiser Event's ID], // this is required if you are placing this for an advertiser event . 
 
order_id: '',// Optional. Order ID for a specific transaction - WooCommerce dynamically generates this value, which must then be passed here. 
  })
</script>

In order for any offers to be approved within our system, the sale amount must be provided. This amount is the sub-total after any coupons or discounts have been applied.

Note that several parameters will need to be passed dynamically into the script for the script to function correctly. If an optional parameter is not being passed into the conversion pixel it should be removed, commented out or passed as a blank value in order for the script to function properly.

Note, when passing an optional parameter, the script will fail without proper sanitization of values.

Implement Plugin (if Clickless Tracking)

In order to implement clickless tracking, coupon codes need to be passed to the appropriate parameter in the Conversion Tracking script.

  1. For WooCommerce, we have developed a simple plugin that allows for the coupon code(s) to be displayed within the DOM and well as directly in the thank-you/order confirmation page.

    Please visit the below link to acquire the plugin to install through the WordPress Admin. This plugin has been tested with WordPress 5.3.2 and WooCommerce 3.9.2.

Note, modification of the plugin is not recommended due to potential conflicts with the WooCommerce base code.

Note, If not using the plugin, the output of the coupon will have to be passed directly to the script in the manner of a sanitized text string.

Test Conversion Event

  1. To see if your test conversion event was successful, return to your affiliate dashboard at https://clients.oneqordigital.com.
  2. Once logged in, navigate to Offers and then select your active offer. If you do not yet have an offer, please create one at this time. For assistance in setting up high-performing offers, please contact Octavius Moore.
  3. After the necessary tracking scripts have been implemented, visit https://yourdomain.com/?offid={insert_offer_id}&affid=1 to cookie that device with the appropriate offer. Replace {insert_offer_id} with the appropriate active offer in the dashboard. This should be presented as a simple integer such as “6” or “34”.
  4. Follow the necessary steps to complete a conversion within the site, ideally within the same session. The conversion should end on the page where the conversion pixel/script has been implemented.
  5. Return to the affiliate dashboard. Navigate to Reporting, then Conversion and the test transaction should appear time-stamped to the time of your test order. If this order does not appear, either your conversion

Note that affid=1 will appear as a conversion from Test Partner (1) within the dashboard.

Support / Contact

If additional assistance is needed in implementing or configuring click, conversion and impression tracking to your WooCommerce installation, please contact:

Octavius Moore for server to server postbacks, offer implementation or general assistance at octavius@oneqor.com 

Marcus Campbell for direct code implementation or general assistance at marcus@oneqor.com   

Leave a reply