The lead goes to undersold campaigns when free Num Slots remained after selling this lead in the shared model. This lead can be sold in the undersold model as many times as many free slots have left. Undersold campaigns are aware that this lead has been sold several times already and buy it at a lower price.
Let’s go through the configuration process. Go to Campaigns, select the desired campaign, click Action -> API Configuration and configure each step:
Step 1: Create Connection
Fill in the required fields as described in the main article and select Undersold Lead Type:
Select either Direct or Ping Post Distribution Type according to buyer specification.
Step 2: Map API Inputs
Distribution Directives - XML
For example below, we use XML formatting and PX API specification.
Map all fields from buyer specification according to Step 2. Map Inputs article. In addition, to make undersold campaign integration work properly, you need to send the following information:
- remaining free num slots - to indicate how many times this lead can be sold;
- which leg(s) should be excluded - in case this lead has been already sold to them.
For this purpose, include Distribution Directives block with AllowUndersold="true" parameter and the number of remaining slots using Shared.AvailableSlots PX field:
If there are legs to exclude from selling, use DistributionDirectives.Directive.Start/End cloning tags so that if there are several excluded legs, they are added automatically.
Add Directive tag with Action=”Exclude” parameter and use one or both names:
- Leg Name - DistributionDirectives.Directive.CompanyName field;
- Hashed Leg Name - DistributionDirectives.Directive.HashName field:
Distribution Directives - HTTP
Here is also HTTP example for Distribution Directives:
Undersold Integration and Perform Check
Sometimes buyer specification requires sending only hashed leg name if it’s specified in the lead, and avoid sending leg name. In this case, Perform Check option should be used.
To configure such an integration, perform the following:
1. Put Perform Check and Close Perform Check tags in the Template Editor:
2. Click on Perform Check tag and configure the condition on the mapping panel when the lead request includes Hashed Leg Name:
- select Distribution directive Hash name in Check Field drop-down menu;
- select Exists in Check Type drop-down menu:
3. Map hashed leg name (DistributionDirectives.Directive.HashName field) that should be sent to buyer API:
Parameters that you map depend on requirements in buyer specification.
4. Put Perform Check~1 and Close Perform Check~1 tags and configure the condition on the mapping panel when the lead request doesn't include Hashed Leg Name:
- select Distribution directive Hash name in Check Field drop-down menu;
- select Not exists in Check Type drop-down menu:
5. Map leg name (DistributionDirectives.Directive.CompanyName field) that should be sent to buyer API:
In such a way, the system will check if there is hashed leg name in the lead request. If yes, system will send hashed leg name to the buyer API and leg name will be avoided. If no, usual leg name will be sent.
Times Sold & Available Slots
Sometimes buyer wants to receive not only information about remaining num slots, but also how many times the lead has been already sold. For this purpose, use Shared.TimesSold PX field:
Further Steps
The rest of the steps are configured according to the corresponding articles:
0 comments
Please sign in to leave a comment.