/
Publisher Bands

Publisher Bands

Platform URL

https://[enterprise].cvtr.io/v2/campaigns/{campaigId}/admin/publisher-bands

API Endpoints

Load campaign details

GET /api/v4/campaigns/{campaignId}?page=1&itemsPerPage=1

Load campaign form fields for creating publisher band

GET /api/v4/processr-form-mappings?page=1&itemsPerPage=100&campaign.id={campaignId}

Create publisher band

POST /api/v4/campaign-payout-bands

Load all publisher bands on campaign on page load/save

GET /api/v4/campaign-payout-bands?itemsPerPage=10&page=1&campaign.id={campaignId}

Update publisher band value(s)

PUT /api/v4/campaign-payout-bands/{publisherBandId}

Delete publisher band

DELETE /api/v4/campaign-payout-bands/{publisherBandId}

Upload csv file for publisher bands

POST /api/v4/files

Import csv file for publisher bands

POST /api/v4/campaign-payout-bands/csv-import

Epic

https://convertr.atlassian.net/browse/DAS-207 https://convertr.atlassian.net/browse/DAS-766

Document status

IN PROGRESS

Document owner

@Danny Hannah @Adam Carter

Technical writers

@Arunima Kurup Prasad

Related Content

Publishers

Feature Overview

Publisher Bands can be defined for a campaign when we want to have different CPL for leads within the same campaign, thus eliminating the need to configure multiple campaigns with similar settings. E.g., publisher bands can be configured with different CPL for different countries. This means, leads from different countries (configured as publisher bands) will have different CPL. Similarly, publisher bands can be configured for emailDomains if we need different CPL to be associated with leads emanating from certain emailDomains.

Publisher bands can be configured at the campaign level and can be accessed from the Campaign > Admin menu.

Screenshot 2024-03-13 at 15.42.32.png

By default, all the buttons (Add, Delete, Import) on the page are disabled. There is an ‘Enable Publisher Bands’ toggle that is disabled by default and can be toggled ON to configure publisher bands on the campaign.

Screenshot 2024-02-01 at 12.04.23.png

Once the toggle is enabled, the ‘Add’ and ‘Import’ buttons are automatically enabled and the user can proceed to adding publisher bands on the campaign either using the Add button or Import button, which is described in upcoming sections of this document.

The Publisher Bands table has the following fields:

Name

Notes

ID

Unique ID to identify a publisher band on the campaign

Field Name

The field that the publisher band is based on

Value

The value that is associated with the CPL configured for that band

Band Name

Name to identify the publisher band

Default Rate

This is the maximum percentage of the CPL that a publisher can receive for a lead

Last Updated

Date/time the publisher band was last updated

Actions

Edit option

The following functionalities are available for Publisher Bands:

i. Enable Publisher Bands

ii. Add

iii. Import

iv. Edit

v. Delete

Enabling Publisher Bands

This is done using the ‘Enable Publisher Bands’ toggle available on top of the publisher bands table. This is disabled by default. Once enabled, publisher bands can be added/imported via CSV. If there are no publisher bands configured, the toggle can be turned off. However, if there is at least one publisher band available, then the toggle will remain enabled and user will not be able to toggle it off. All publisher bands need to be removed before the toggle can be disabled.

Add Publisher Band

Publisher bands can be added using the ‘Add’ button which is enabled when the ‘Enable Publisher Bands’ toggle is enabled. User sees the below modal when clicking the Add button.

All fields in the modal are mandatory.

‘Form field’ is a dropdown consisting of all available core fields and the form fields. The field that needs to be configured as the publisher band can be selected from this dropdown, e.g. country, emailDomain, channel, publisherName etc.

Next, the user must supply the ‘Value’, which is the value associated with the publisher band.

User can provide a ‘Band Name’ and a ‘Default Rate’ percentage. Default rate percentage overrides the ‘Default Publisher Rate’ configuration in Campaign Settings > Financials.

The recommended value for Default Rate is 100% unless B2C.

In the above example, the CPL (per action payout amount) is £10 and the ‘Default Publisher Rate’ is 10%. This means a publisher gets paid 10% of the CPL for a billable lead, which in this case is:

10% of £10 (CPL), which is £1 per lead.

The amount the publisher gets paid per lead can be changed using publisher bands by configuring the ‘Default Rate’ in publisher bands.

In the below example, the ‘Default Rate’ for leads with emailDomain = ‘Microsoft’ is set to 50%.

This means by delivering a valid lead with emailDomain = ‘Microsoft’, the publisher can get paid up to 50% of the CPL, which is:

50% of £10 (CPL) = £5

Thus, the revenue that a publisher earns can vary for each lead based on the default rate configured at the publisher band level.

Importing Publisher Bands

Multiple Publisher Bands may be imported to a campaign using the ‘Import’ button.

When the 'Import' button is clicked, the below modal opens, where the user can download a sample template for the CSV file and a link to upload the CSV file containing the publisher bands.

A screenshot of the template that is available for download is shown below.

Th user can fill in the values in the CSV file and upload it in the modal. A sample CSV file for upload is shown below.

Uploading the CSV file

Once import is completed, the publisher bands will be listed in the table.

Editing publisher bands

A publisher band may be edited using the ‘Edit’ button available in the Actions column. Any of the values may be edited and saved in the ‘Edit Publisher Band’ modal.

Deleting Publisher Band

Individual bands or multiple bands may be deleted from a campaign using the ‘Delete’ button available on top of the table. The button is disabled by default and is enabled only when the checkbox available against any of the bands is clicked. Delete option selects the bands that were selected using the checkbox(es).

Example using publisher bands

Publisher bands have been configured for ‘country’ field on a campaign, as shown below.

Default rates are different for the various bands.

Four publishers are assigned to the campaign and their requirements are configured in the 'Contract Terms. Example of contract requirements based on bands is shown below.

Publisher 1- contract requirements

Requirement is 10 leads each from each of the publisher bands and 10 from the default band. Any lead that does not fall into the specific publisher band is considered as a default value. In this case, any lead that does not have country code GB, ES, DE or US will go into the default band.

‘Caps on Bands’ is the maximum number of leads allowed on that band. Any lead delivered over the cap will not be billable for publisher and will be marked as overdelivered. It will be billable for the advertiser as long as campaign cap is not met for capped campaign. If the campaign cap is met, the lead will not be billable for advertiser.

Similar requirements are configured for 2 more publishers. For the fourth publisher however, the requirements are not configured based on publisher bands.

Publisher 4- contract requirements

Here, the ‘Allocation Type’ is ‘Default’, meaning all leads (maximum 50 as configured in ‘Allocation’) will be billable, irrespective of the country field (publisher band).

The overall publisher requirements is available in Campaign > Publishers page

When publishers import leads to the campaign, the ‘country’ field in the lead is checked against the configured publisher band(s). When the value of the country matches that of any of the bands and that lead is valid, it will be marked as billable under that band. If the value of country in the lead does not match any of the bands, the lead will be considered to be part of the default band.

Below shows the number of leads, payout and earnings of the publishers for the various bands.

Payout and Earnings based on bands

Publisher 1

For the above publisher, the earnings are calculated as follows:

Billable leads by band

Payout amount per band

Earning per band

Billable leads by band

Payout amount per band

Earning per band

Default band: 12

Default band: £1

12*1= 12

GB:5

GB: £2.5

5*2.5= 12.5

ES:9

ES: £1

9*1= 9

DE:5

DE: £1.5

5*1.5= 7.5

US:9

US: £2.5

9*2.5= 22.5

Total Earnings: 12+12.5+9+7.5+22.5 = £63.5

In the above case, since there is no cap per band, all leads, including default leads are billable irrespective of the country.

Publisher 2

For the above publisher, the earnings are calculated as follows:

Billable leads by band

Payout amount per band

Earning per band

Billable leads by band

Payout amount per band

Earning per band

Default band: 0

Default band: £1

0*1= 0

GB: 10

GB: £2.5

10*2.5= 25

ES: 10

ES: £1

10 *1= 10

DE: 9

DE: £1.5

9*1.5= 13.5

US: 9

US: £2.5

9*2.5= 22.5

Total Earnings: 25+10+13.5+22.5 = £71

In this case, even though there are 12 valid leads that fall under the default band, they are not billable to publisher as the requirement for default leads is 0 for the publisher.

Thus, publisher bands determine the earnings received by a publisher. Different rates can be associated with different publisher bands and CPL changes with the band that it is associated with.

Each time publisher bands are added/edited/removed, contract terms must be updated and new contract will be created for each publisher assigned to the campaign. The new contract must be signed before the publisher can import leads to the campaign

Summary

Functionality

User Story

Functionality

User Story

1

Add Publisher Bands

Admin and Agency users can add publisher bands at campaign level either using ‘Add’ button or using the ‘Import’ option to import a CSV file of publisher bands

2

Enable Publisher Bands

Admin and Agency users can enable publisher bands on a campaign. Once enabled, it is not possible to disable publisher bands until all publisher bands have been deleted

3

Edit and Delete publisher bands

Admin and Agency users can edit all values associated with a publisher band and can also delete bands

4

Table Filtering

Allows the user to filer the table values using column names

5

Custom Tables

A user can add, remove and reset columns for custom table

 User Permissions

Only Admin and Agency users have access to Publisher bands.

https://docs.google.com/spreadsheets/d/1i4qTTKkC3rF3EyEOh2585ktDDGge0L0IMVDNCwriFR0/edit#gid=415459484

Related content

Value Transforms
Value Transforms
Read with this
Publishers
More like this
Setup
More like this
Actions > Contract Terms
Actions > Contract Terms
More like this
Publisher Listing
Publisher Listing
More like this
Campaign Listing
Campaign Listing
More like this