Publisher Listing
- Arunima Kurup Prasad
Platform URL | https://[enterprise].cvtr.io/v2/campaigns/{campaignId}/publishers |
|---|---|
API Endpoints | Load Campaign Details
Load Campaign Publisher list
Resend Publisher Contract/Update Contract Terms
Enable/Disable
Listing table: custom column
Totals table: custom column
|
Epic | |
Document status | READY FOR REVIEW |
Document owner | @Danny Hannah @Adam Carter |
Technical writers | @Arunima Kurup Prasad |
Related Content |
Feature Overview
Publisher assignment to a campaign can be done by Admin and Agency users, using the Campaign > Publishers page. This page can be accessed by selecting the campaign from the dashboard and clicking on the Publishers tab.
This page shows the details of assigned publishers, publisher breakdown details, and total leads details.
The sections available on this page are detailed below.
Publisher Breakdown widget
This widget shows the below details:
i. Total earnings for all publishers assigned on the campaign.
ii. Number of publishers
iii. Number of active publishers
iv. Number of publishers who have not signed the contract
v. Number of publishers that have been disabled on the campaign
Leads breakdown graph
This graph shows the number of billable leads and number of remaining leads per publisher
Publishers table
This table lists the details of all publishers assigned to the campaign.
The following details are available in this table by default:
Column Name | Description |
Id | Publisher Id |
Lead Generator | Name of the publisher |
Contract Status | Unsigned: When contract is not signed by publisher Active: When contract is signed and publisher has not delivered the required number of leads Inactive: There are 2 ways publishers can be inactive on a campaign.
|
Enabled | The publisher will be able to deliver leads to a campaign only if this toggle is enabled for them If the campaign is inactive, the toggle will be disabled |
Contract Type | CPL |
Processing | Number of leads that are in processing state |
On Hold | Number of leads that are in hold state (awaiting batch or scheduled delivery) |
Total Leads | Total number of leads submitted by the publisher |
Valid | Total number of valid leads submitted by the publisher |
Invalid | Total number of invalid leads submitted by the publisher |
Billable | Total number of billable leads submitted by the publisher |
Required | For capped campaigns, this will be Total number of leads required from the publisher For uncapped campaigns, this will have different values based on the cap selected for the publisher.
|
Payout | Payout value configured for cap/per band |
Earnings | The total earnings made by the publisher for the billable leads |
Actions | A number of actions are possible, as detailed in this page |
Apart from the above, the user can select the ‘Custom Table Views’ option to add/remove columns. Additional columns that may be added are:
Name | Notes |
Impressions | Number of impressions |
Clicks | Name of clicks |
Conversions | Number of clicks converted to leads |
Last Conversion | Date when a click was last converted |
Pending Batch | Number of leads pending batch |
Apart from custom table views, the publisher table also provides a number of search and filter options.
Pagination and table level refresh are also possible on the Publishers table.
Actions
The ‘Actions’ column is as shown below and provides 3 actions:
Edit Contract
Tracking Information
Contract History
The above actions are detailed in other pages mentioned in Related Content.
Totals Table
The last section in this page is the Totals table, which is the bottom most table. This table provides the numbers for all publishers on the campaign.
The columns available by default in this table are:
Column Name | Description |
Processing | Number of leads that are in processing state, for all publishers combined |
On Hold | Number of leads that are in hold state (awaiting batch or scheduled delivery), for all publishers combined |
Valid | Total number of valid leads submitted by all publishers on the campaign |
Invalid | Total number of invalid leads submitted by all publishers on the campaign |
Billable | Total number of billable leads submitted by by all publishers on the campaign |
Required | This is the sum of required leads from all publishers. Value will be based on whether campaign is capped or uncapped, as described in the ‘Required’ column in Publishers table above |
Earnings | The total earnings made by all publishers on the campaign for their billable leads |
Current Allocated Amount | For capped campaigns, this value is a fraction that shows ‘Total Number of leads allocated to publishers’/'Total Campaign Requirement' For uncapped campaigns, this will be ‘N/A’ |
Apart from the above, the user can select the ‘Custom Table Views’ option to add/remove columns. Additional columns that may be added are:
Name | Notes |
Impressions | Number of impressions for all publishers combined |
Clicks | Name of clicks for all publishers combined |
Conversions | Number of clicks converted to leads for all publishers combined |
It is also possible for the user to perform a table level refresh for this table to see the latest numbers.
Summary
Summarise the functionalities in a table
Functionality | User Story | |
|---|---|---|
| 1 | Publisher Breakdown widget | Admin, Agency and Advertiser users can see Number of publishers, number of active/unsigned/disabled publishers and total earnings for all publishers assigned on the campaign |
| 2 | Leads breakdown graph | Admin, Agency and Advertiser users can see number of billable leads and number of remaining leads per publisher |
| 3 | Publishers table | Admin, Agency and Advertiser users can see all publishers assigned on the campaign |
| 4 | Totals table | Admin, Agency and Advertiser users can see total numbers of all publishers assigned on the campaign |
| 5 | Table Filtering | Admin, Agency and Advertiser users can search and filter the publisher table on various values |
| 6 | Pagination | Admin, Agency and Advertiser users can use the pagination option to see different number of rows of publisher data |
| 7 | Custom Tables | Admin, Agency and Advertiser users can add, remove and reset columns using custom table for Publisher table and Totals table |
User Permissions
Admin, Agency and Advertiser users have access to the page. Actions on the page can be performed only by Admin and Agency users. For details of user permissions, please refer to the user matrix below.