1. Overview
2. Transaction Types
4. Item-Specific Commissions in Detail
5. Pixel Integration
5.2. Pixel Parameters Explained
5.3. Real-World Integrations 5.4. Additional Functionality
6. Testing Your Pixel Integration
7. Pixel Integration Problems
8. Uploading Items
9. Common Phrases and Definitions
1. Overview
This document assists advertisers with itemized pixel integration.
No Personally Identifiable Information (PII) may be passed to Pepperjam. PII includes but is not limited to information which can be used to distinguish or trace an individual's identity, such as their name, social security number, email address, phone number, or physical address.
2. Transaction Types
2.1. Lead
A publisher is paid a flat amount when they direct a consumer to an advertiser's website and that consumer fills out a membership form, registers online, starts a subscription, or similar.
2.2. Sale
A publisher is paid a percentage of the sale when they direct a consumer to an advertiser's website and that consumer purchases a product or service.
3. Advertiser Types
3.1. Standard Advertiser
This type of advertiser logs all sales or leads through Pepperjam. Tracking these sales and leads can be done from anywhere in the advertiser's website and does not require a specific "landing page".
3.2. Gateway Advertiser
This type of advertiser uses a URL with special parameters that are used to indicate the source of traffic and determine whether or not to display the pixel on the order confirmation page.
4. Item-Specific Commissions in Detail
Item-specific commissions let advertisers have separate commission rates for different products. First, a base or default commission rate is set, 10% for example. Now it is possible to create special commission rates. For example, an artificial Christmas tree company would increase commission for trees to 15% around Christmas to move more trees. Stands, lights, etc. will still earn 10% commission, but trees now generate 15% commission.
5. Pixel Integration
The pixel is located in the HTML of your confirmation/thank you page that is displayed after a successful sale or lead. This page has the final details such as the sale amount, products or services purchased, and the tracking data. The pixel must also contain other, static (unchanging), data. There should only be one pixel on the confirmation page.
Pixels are very flexible and can be used with many programming languages, including (but not limited to): PHP, Javascript, CGI Scripting, ASP, Perl, and Java.
5.1. Pixel Examples
<iframe src="https://t.pepperjamnetwork.com/track?PID=<PROGRAMID>&INT=ITEMIZED &ITEM1=<ITEM1ID>&ITEM2=<ITEM2ID> &QTY1=<QTY1>&QTY2=<QTY2> &AMOUNT1=<AMOUNT1>&AMOUNT2=<AMOUNT2> &OID=<OrderID>&CLICK_ID=<ClickID>" width="1" height="1" frameborder="0"></iframe>
Values within the <> brackets must be assigned programmatically. A live pixel should look similar to the following:
<iframe src="https://t.pepperjamnetwork.com/track?PID=000&INT=ITEMIZED &ITEM1=P1473&ITEM2=P1894 &QTY1=3&QTY2=4 &AMOUNT1=25000.99&AMOUNT2=10.00 &OID=54563131&CLICK_ID=654237" width="1" height="1" frameborder="0"></iframe>
5.2. Pixel Parameters Explained
| Field Name | Description | Example |
|---|---|---|
| PID | Program ID | 123 |
| INT | Type of integration | ITEMIZED |
| ITEM(X) (ex: ITEM1, ITEM2) |
Item ID (product SKU) Allowed Characters: Alpha-Numerics (A-Za-z0-9), dashes(-), underscores(_), periods(.), colons(:) (This value must be unique to the pixel) |
SKU-13543422 |
| QTY(X) (ex: QTY1, QTY2) |
Quantity of the items. Must be a non-negative integer. | 2 |
| AMOUNT(X) (ex: AMOUNT1, AMOUNT2) |
The sale amount for the single item. The amount should reflect any coupon or discount that is applied to an order and should be before shipping/taxes. This field may be set to zero (0) for lead (flat payout) transactions. NOTE: The amount passed through in this field can only be a numeric value and cannot contain any characters, such as commas for amounts that are greater than one thousand dollars. If a comma exists within the amount field, it will generate an error in the system and not track properly. |
25000.99 |
| OID | Order ID Allowed Characters: Alpha-Numerics (A-Za-z0-9), dashes(-), underscores(_) |
FT-13543422 |
| CLICK_ID | Unique ID assigned by Pepperjam to each click record generated from a creative. This value is passed to the advertiser's website as the placeholder clid in the creative destination URL. This will need to be captured and stored so it can later be passed back in your pixel fire. NOTE - This parameter is not required if you are currently using the Pepperjam Container Tag. However, if you are not using the Pepperjam Container Tag, please see the additional info link below to learn more about creating your own ITP mitigation functionality. Usage: The most recent click ID associated with the transaction's customer. Additional Info: See Click ID Capture and Storage for more information. |
654237 |
| PROMOCODE (optional) | A single or comma-separated list of promotional codes tied to a personalized coupon. It is used to ensure credit is given to the owner of the personalized creative, rather than someone who may have used it without permission. If a list is provided, the first valid code will be used. If a valid code is not provided, the sale will be attributed as normal. This is an optional parameter and requires additional setup by your account manager. | MYPROMO1 |
|
SIGNATURE (optional) |
A hashed order id (OID) using the SHA256 hash with the private key saved by the advertiser in the pixel signing portion of the site Pixel Signature Generation Code Examples. Note: The code that generates the signature value, including the secret, should not be referenced in a way that is exposed to the user. |
f0441870c51c73526f9d8fdb4a47593 |
5.3. Real-World Integrations
HTML Integration
Example taken from Section 5.1
<iframe src="https://t.pepperjamnetwork.com/track?PID=000&INT=ITEMIZED &ITEM1=P1473&ITEM2=P1894 &QTY1=3&QTY2=4 &AMOUNT1=25000.99&AMOUNT2=10.00 &OID=54563131&CLICK_ID=654237" width="1" height="1" frameborder="0"></iframe>
PHP Integration
Example taken from Section 5.1
<?php $output = '<iframe src="https://t.pepperjamnetwork.com/track?';; $output .="PID=000"; $output .="&INT=ITEMIZED"; $output .="&ITEM1=$itemID1"; $output .="&ITEM2=$itemID2"; $output .="&QTY1=$quantity1"; $output .="&QTY2=$quantity2"; $output .="&AMOUNT1=$salePrice1"; $output .="&AMOUNT2=$salePrice2"; $output .="&OID=$orderID"; $output .="&CLICK_ID=$clickID"; $output .='" width="1" height="1" frameborder="0"></iframe>'; echo $output; ?> <-- This will create the following: //--> <iframe src="https://t.pepperjamnetwork.com/track?PID=000&INT=ITEMIZED &ITEM1=P1473&ITEM2=P1894&AMOUNT1=25000.99&AMOUNT2=10.00 &QTY1=3&QTY2=4&OID=54563131&CLICK_ID=654237" width="1" height="1" frameborder="0"></iframe>
5.4. Additional Functionality
A single or comma-separated list of promotional codes tied to a personalized coupon. It is used to ensure credit is given to the owner of the personalized creative, rather than someone who may have used it without permission. If a list is provided, the first valid code will be used. If a valid code is not provided, the sale will be attributed as normal. This is an optional parameter and the feature requires additional setup by your account manager.
<iframe src="https://t.pepperjamnetwork.com/track?PID=<PROGRAMID>&INT=ITEMIZED &ITEM1=<ITEM1ID>&ITEM2=<ITEM2ID> &QTY1=<QTY1>&QTY2=<QTY2> &AMOUNT1=<AMOUNT1>&AMOUNT2=<AMOUNT2> &OID=<OrderID>&CLICK_ID=<ClickID>&PROMOCODE=<promo1>,<promo2>" width="1" height="1" frameborder="0"></iframe>
6. Testing Your Pixel Integration
Before making any changes to test for successful pixel integration, it is important to create a backup for any page or pages that will be modified. It is important to test the pixel on your confirmation page to make sure that everything is working properly. Pixel code should be placed on the Confirmation or Thank You Page.
Pepperjam will manually review your submitted HTML code and also manually complete a test sale to make sure that the integration was performed successfully. Periodically, the Pepperjam staff may run tests sales to make sure that the pixels are still working correctly.
7. Pixel Integration Problems
Correctly working pixels and tracking cookies are extremely important to a successful marketing campaign. Be sure that you completely understand how to implement pixel tracking. Problems such as incorrect reports can be caused from incorrect values being entered into the tracking pixel at the time of sale. At least one successful test must be completed. The correct information must be set in the pixel so that the tracking and reporting systems function properly.
8. Uploading Items
In order for itemized tracking to work, a flat text file must be hosted by the advertiser. That text file must include the following pipe-delimited fields:
Item Name|Item ID|List ID
| Item Name | The unique item or product name associated with a specific payout. |
| Item ID | The unique item or product ID associated with a product; the item ID corresponds to the ITEM(X) (ex: ITEM1, ITEM2) parameter of the tracking pixel. Allowed Characters: Alpha-Numerics (A-Za-z0-9), dashes(-), underscores(_), periods(.), colons(:) |
| List ID | The list ID associated with the product; one list ID may correspond with many products; list IDs are generated using the Pepperjam web interface by clicking "Partner Program Terms" under the "Manage Partners" drop-down menu. Next, click on "Manage Product Lists" (top-right of the page); next to each list that is created, the list ID is displayed in parentheses. |
The advertiser-hosted text file must be pipe (|) delimited and should look something like the following:
Product Name 1|PRODUCT_ID_001|101 Product Name 2|PRODUCT_ID_002|102 Product Name 3|PRODUCT_ID_003|103
The itemized list must be hosted on the internet.