Publishers
- Danny Hannah
- Arunima Kurup Prasad
- Vijay Alexander
- Adam Carter
Platform URL | |
|---|---|
API Endpoints | Add Publisher POST - Import Publishers POST - Edit Publisher PUT - Delete Publisher DELETE -
List all Publishers GET - Populate country dropdown GET- List all Campaign for Publisher GET - Publisher Statistics GET - Publisher Lead Statistics GET - Get details of Publisher bands for the campaign GET - Resend Assets POST -
Tracking Info GET -
Contract History GET - List All lead mapping template GET -
Lead Import POST -
Lead Export GET-
GET-
GET- POST - Bulk Edit GET- GET- POST - Campaign Performance Report POST - Campaign Information GET -
|
Epic | |
Document status | REVIEWED |
Document owner | @Danny Hannah @Adam Carter |
Technical writers | @Danny Hannah @Adam Carter @Arunima Kurup Prasad @Vijay Alexander |
Related Content |
Feature Overview
Within the Convertr platform, Publishers are the lead data providers.
Admin and Agency users can assign publishers to a campaign. When assigned to a campaign the publisher is given a number of billable (valid & delivered) leads that they are able to fulfil and an amount that they will be paid for each lead.
Publisher users will log into the platform and have a limited view whereby they can see basic reporting, lead data delivery, tracking information and information rules on campaigns that the Publisher ‘organisation(s)’ has been assigned to deliver lead data.
Signing Publisher Contract
Before they can submit lead data into the Convertr platform, the Publisher user must agree to the Ts&Cs which are defined by the Admin and Agency users and is distributed by email.
In some cases, it is possible to have the publisher contract auto signed at the time of assignment (See Campaign Admin setup for details)
Create and Manage Publisher ‘organisation(s)’ Accounts
Admin users and Agency users can add, edit and delete publisher accounts on the platform. The core information they would like to be able to store is a company name and basic contact information for the main stakeholder.
They should also be able to assign users to this company so that they can log in to the system and perform the tasks detailed below.
Assigning Publisher(s) to a campaign
Admin users and Agency users can also assign publishers to a Campaign (See Campaign Publisher Management page).
When adding a publisher they should be able to choose to send a welcome email to the contact email address, which will allow the user to sign up and be linked to the new organisation (See Campaign Admin Setup page).
Once logged into the platform, the publisher can see ‘Leads breakdown’ widget and graph, all the campaigns that they are/were assigned to. The table has option for pagination and to download the contents of the page as a CSV file. Using the ‘Custom Table Views’ option, the user can customise the columns they wish to see in the table.
Some columns also have search filters and sorting options.
The Actions column shows the actions that the publisher can perform on each of the campaigns. These are:
Import Leads
Export Leads
Bulk Edit
Resend Assets
Tracking
Contract History
Campaign Performance Report
Campaign Information
1. Importing leads to a campaign
If the campaign setting ‘Allow Publishers to import and export their data' is enabled on a campaign, the publisher user will be able to see the 'Import Leads’ option against the campaign.
Publisher users can import data into a campaign using the ‘Import Leads’ option available against a campaign on the Publisher Campaigns listing page.
This will open a ‘Import Leads’ modal which allows the user to upload a CSV file containing lead data. A sample file is available for download in the link in the blue banner in the modal.
All forms associated with the campaign are available in the ‘Select a form’ dropdown. The user must select the appropriate form and upload the CSV file. Different delimiters are supported in the CSV file- comma, semicolon, tab, pipe. The appropriate delimiter may be selected and the user can proceed to the next step.
The user will be able to proceed to the next step only if they have selected the form and uploaded a CSV file.
On the next step, the publisher’s name is automatically populated in the ‘Publisher’ field. They can also provide a tracking link. Select a tracking link helps to identify the channel the imported leads will be applied to. If left unset, the channel for each imported lead will be empty.
There is also an option ‘Replacement’ which may be set if the leads being imported are replacement leads. By enabling this, within reporting it will be noted that the imported leads are replacing previously returned lead(s) as 'make good'. This has no impact on processing and is used for reporting purposes only.
On the next step, they can manage previously saved mapping templates. They can select a template from the dropdown to load or delete a chosen template, or reset the field mapping to the original state. Once they map their data to the campaign form, they can save the mapping setup as a new template for future imports.
On the final step, the user can preview their import (10 rows of data) and opt-in that the data was captured lawfully. They can always go back to a previous step to e/dit any information. Once verified, the leads will be imported into the campaign on clicking Save.
2. Exporting Leads from a Campaign
If the campaign setting ‘Allow publisher users to import and export their data' is enabled on a campaign, the publisher user will be able to see the 'Export Leads’ option against the campaign. Publisher users can export all publisher data that the specific publisher has submitted to a campaign using the ‘Export Lead’ option available against a campaign on the Publisher Campaigns listing page.
This will open a page where the user can filter by status, timeframe (max 1 year), and by QA flags, the data they want to export. They can set the order of the export- ASC or DSC. They can also choose to export the data as CSV file.
If the publisher user has multiple publishers assigned to the user account they can also filter by publisher.
They will also be able to export all rows of publisher data or by selecting the columns they want to export. When selecting this can be done by dragging and dropping options or by selecting the whole section. (needs to be updated after migration)
After configuring their options they can then rename the selected columns for export as well as reorder and/or delete their selections.
Once exported, the report will then go to the Exports sections for the user to download. Here, the user can click on Download to export the report to their environment.
3. Bulk Edit
If the campaign setting ‘Allow Bulk Editing of data' is enabled on a campaign, the publisher user will be able to see the 'Bulk Edit’ option against the campaign.
Using the ‘Bulk Edit’ feature, a publisher can edit data on multiple leads without having to action each lead individually. To use bulk edit, the publisher must first ‘Export’ the leads on the campaign using ‘Lead Export’ option.
Next, in the CSV file, they should make the necessary changes to the lead data, e.g., update the company_size, job_title etc.
The next step is to select the ‘Bulk Edit’ option available against the campaign to upload the updated CSV file.
On step 1: Upload, the user must select the form and upload the updated CSV file.
On step 2: Mapping, the form fields must be mapped to the CSV file. All CSV fields will be defaulted to ‘Do Not Change’.
‘Lead Id’ is a mandatory field and must be mapped to the lead Id field in the CSV file. The changes will be made only if the lead Ids on the campaign match those in the CSV file.
For the fields that need to be updated, the user must select the appropriate field name from the CSV file to map them correctly.
On Step 3: Preview, the user will be shown 5 rows previewing the changes to the selected fields. A banner will be displayed showing the number of leads that will be affected by the change. The user has to accept the confirmation checkbox to enable the Save button.
When the user clicks on Save, the below confirmation box is shown where the user has to enter the number of leads that will be affected by the change.
If the user enters the correct value and clicks on Yes, the changes will be made to the leads and an email will be sent to the user confirming the changes.
4. Resend Creative Assets
The user will be able to re-send any creative assets on the selected campaign. When resending the assets, they will have to confirm that they wish to resend.
Once this is confirmed, they will receive an email (which is linked to the publisher) with a link where they can download a zipped file with all of the assets on the campaign.
5. View Tracking for the Campaign
Publisher users can view the tracking links, Impression tags and API credentials (the API credentials will only be available if they have created a user) in a modal for that specific publisher on the selected campaign.
Tracking Links allow visibility on performance across data providers. They can be used on outbound links and buttons within an email creative or within publisher websites to track various statistics such as impressions, clicks, conversions, etc.
The Impression Tag allows reporting on the number of times this link has been displayed for the Advertiser. It can be implemented within an email creative or within a publishers website on every page that includes the related Convertr Tracking URL.
6. View and Download Signed Contracts for the Campaign
Publisher users can sign any unsigned contracts using the ‘Contract History’ option.
Users can see and download all signed contracts on the selected campaign.
7. Download Campaign Performance Report(s)
Publisher users can download a breakdown of the campaign performance using the option available against the campaign. They need to agree to the terms and conditions before downloading the report.
The report includes all key campaign performance metrics including Impression, clicks, etc. along with the line item breakdown of all the records.
8. View Campaign Information
By clicking on the ‘Campaign Information’ option, publisher users can view selected ‘Simple Conditional Validation Jobs' and ‘Validation Lists Jobs’ which have been specified by an Admin or Agency user under the 'Job Breakdown’ tab. For both the Simple Conditional Validation and Validation List Jobs, the Publisher User has the option to download the list of values associated with them. When downloading a simple conditional validation job this will generate a local browser download.
When downloading a validation list job this will generate a download which will be accessible via the export section.
To show the Job Breakdown details to the Publisher, Admin / Agency user has to enable it in Campaign > Admin > Setup.
The Publisher user can see the logic that they need to submit the lead data for it to pass the check, e.g.
Criteria
Equal
Contains
Endswith etc.
Condition
Pass
Fail
The Publisher user will be able to see the Publisher notes on the campaign that have been populated by the Admin or Agency User on the campaign (See campaign admin setup page).
Reports
The publisher user can access and download Publisher performance report.
The report shows Publisher Performance overview, performance graph, and campaign breakdown details.
There is an option for the user to download the campaign breakdown as a CSV file. There is also a search bar where the user can search for campaign details from the campaign breakdown table.
Clicking on ‘Show All’ against a campaign shows allocation details of the campaign.
The user can also download the publisher performance report by clicking the ‘Download’ button. By accepting the terms and conditions, the report will be available for download in Exports.
The report can then be downloaded from the Exports folder by agreeing to the export conditions.
Notifications
The publisher user can see a summary of notifications by clicking on the bell icon. By clicking on View All, they can see all the reports that are ready for download. These may be downloaded asPDF or Zipped files.
The CSV download of the notifications can be got using the CSV button.
Summary
Functionality | User Story | |
|---|---|---|
| 1 | Value Transformation Listing | Users can see the value transforms listing and edit the ‘Label’, ‘Original Name’ and ‘New Name’ fields |
| 2 | Value Transformation > Add | Users can add value transform values using the Add button |
| 3 | Value Transformation > Add/Edit | Users can add and edit value transforms using the Add/Edit button |
| 4 | Value Transformation > Delete | Users can select and delete multiple value transform lists at a time |
| 5 | Value Transformation > Import | Users can import CSV file for 'transform' type of value transforms |
| 6 | Value Transformation > Group Listing | Users can see the value transforms groups listing and edit the ‘Id’ and ‘Group Name’ fields |
| 7 | Value Transformation > Group > Add | User can create value transform groups in which value transforms can be grouped |
| 8 | Value Transformation > Group > Add/Edit | User can add/edit value transform groups |
| 9 | Value Transformation > Group > Delete | User can delete value transform groups |
| 10 | Value Transformation > Table Filtering | Allows the user to filter the table values using Id, Original Name and New Name fields |
| 11 | Value Transformation > Group > Table Filtering | Allows the user to filter the table values using Id and Group Name fields |
User Permissions
Publisher ‘organisation(s)’ are created on the platform by an Admin or Agency user, as a listing and a publisher (publisher user role) user is created and associated to the Publisher ‘organisation(s)’ to manage that account.