__________________________________________________________________________________________________________________

This article will review:

• This particular process is aimed at agencies and partners who have greater responsibility over their integrations and are mostly self sufficient
• It will cover:
  • The initial technical implementation steps required to adopt the Self Serve model 
  • The stages in the onboarding process to create and launch a new campaign (once initial technical implementation has been completed)
  • The roles and responsibilities for each onboarding stage
  • Detailed tracking implementation options and testing verification
  • Access to additional onboarding documentation

__________________________________________________________________________________________________________________

Index

• Overview
• Initial Technical Implementation
• Onboarding Steps
• Default Campaign Settings
• Tracking Solution to Implement
• Testing and verification
• Next Steps

Overview

When brands create new campaigns on Partnerize, there are various stages to the onboarding process to ensure a smooth transition.  Agencies and partners can manage the majority of the onboarding process, if required.  Alternatively, they can follow the 'standard' integration process, where the Partnerize Integrations team are more heavily involved (see Partnerize Onboarding Process)

However, should an agency, brand or partner want to be more self service, they can opt for a custom network onboarding process, where predefined requirements and options are agreed up front, and are then applied to all future campaigns that are required.  This provides the agency, brand or partner with greater control over their integration process and will result in the campaign implementation time being significantly reduced, due to the streamlined process.

Initial Technical Implementation

To adopt the Self Serve model, agencies and partners must develop a solution that can interact with the Partnerize API to create new advertisers and campaigns.  More information on how to implement these processes via the Partnerize API can be found below:

• Create Advertiser (Brand): https://api-docs.partnerize.com/brand/#operation/Create%20Brand%20Account
• Create Campaign: https://api-docs.partnerize.com/brand/#operation/Create%20a%20Campaign

Agencies and Partners may also want to develop this solution further and integrate with the Partnerize API to complete the below actions which may be needed as part of the Onboarding process, but these actions can also be easily performed via the Partnerize platform:

• Create Partnerize Tag (in the event that a brands wants to use this as a tracking solution): https://api-docs.partnerize.com/brand/#operation/createPartnerizeTag

• Enable Partnerize Tag FPT feature (in the event that a brands wants to use this as a tracking solution): https://api-docs.partnerize.com/brand/#tag/Partnerize-Tag-Features

• Approve test partners onto campaigns: https://api-docs.partnerize.com/brand/#operation/update-partner-participation

Support will be provided by the Technical Onboarding team whilst the solution is being developed and tested. 

Onboarding Steps

Once the technical implementation above is completed, new campaigns can be created via the Partnerize API as soon as the need arises.  The below steps should be adhered to when creating any future campaigns once the Self Serve Model is in place:

Default Campaign Requirements

For all campaigns on the network, standardised requirements and campaign settings will be used​. There will still be options for technical variations per campaign (Destination URL, Campaign Name etc), and this can be included in the new campaign request.

Below are the standard settings that will be set for all networks that utilise this integration process: 

Tracking Solution to Implement

We recommend that the following approach is taken to web tracking:

• A web tracking solution is implemented which uses 1st party cookies.  Available options:
  • Partnerize Tag First Party Tracking - Implementation guide here: https://help.phgsupport.com/hc/en-us/articles/360020029897-Partnerize-Tag-First-Party-Tracking-Integration
  • Server to Server - Implementation guide here: https://help.phgsupport.com/hc/en-us/articles/360020395238-Partnerize-Server-to-Server-s2s-Tracking-Integration
• Tracking parameters to be included within the implemented solution should be either the standard parameters or vertical specific.  This is covered in this guide: https://help.phgsupport.com/hc/en-us/articles/4410042606225-Vertical-Specific-Tracking-Parameters

As agencies and partners may have multiple campaigns with different brands, it is still possible to implement different solutions for different brands, depending on the individual requirement.  However, tracking parameters should be standardised.

In addition to the above solutions, should any brands be working with eCommerce platforms, we also have the following integrations:

• Shopify - Implementation guide here: https://help.phgsupport.com/hc/en-us/articles/360018790917-Partnerize-Shopify-Integration
• Magento - Implementation guide here: https://help.phgsupport.com/hc/en-us/articles/360018839357-Partnerize-Magento-Integration
• Salesforce Commerce Cloud - Implementation guide here: https://help.phgsupport.com/hc/en-us/articles/360018499697-Partnerize-Salesforce-Commerce-Cloud-Integration

Testing and verification

Once tracking has been implemented, a test order must be placed on the live brand site to ensure that tracking has been successfully implemented. The tests must be reviewed and meet criteria referenced below, before tracking implementation can be signed off.

Step 1: Place test order

Place the test order as per the instructions in this document:

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

Step 2 : Check Partnerize to verify test transaction

There are two ways in which to check if the test conversion has tracked and also the validity of the data:

• Via the Partnerize platform
• Via the Partnerize API

Option 1 : Check conversion data via Partnerize platform

• Log in to the Partnerize platform
• Access the campaign that is being tested
• Navigate to Analytics > Transaction Report
• If the conversion has tracked, this should appear in the Reporting Table:

• You can then perform the checks (see Step 3 for detailed instructions on what should be checked).  You can check the item level data using the Conversion Items table, shown above, and check any additional item metadata by exposing the data points via the 'Columns' drop down

Option 2 : Retrieve conversion data via Partnerize API

Use the below API endpoint to retrieve the conversion data:

https://<app_api_key>:<user_api_key>@api.partnerize.com/reporting/report_advertiser/campaign/<campaign_id>/conversion.json?conversion_reference=<order_id>

The below values will need to be injected into the relevant parameter within the API call:

Populated API call example (NOTE: Example values have been used for illustration purposes):

https://abcdef:ghijkl@api.partnerize.com/reporting/report_advertiser/campaign/100l12345/conversion.json?conversion_reference=348876522

Once the above values have been injected, the API call can be pasted into your browser

If a transaction has tracked successfully, you will receive a response containing all of the conversion data associated with the order. The response should appear like the below example screen shots:

Step 3: Testing verification & success criteria

If a successful response is received, check each test order for the following:

If any of the above tests fail and do not meet the success criteria outlined above, then this will need to be reviewed by the agency / brand / partner. Once resolved, a further test will need to be placed and checked in the same way as above.

Troubleshooting tips:

Next Steps

Contact your Partnerize Sales representative or Customer Success Manager if you are interested in adopting the Self Serve Integration model.