Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 2 Current »

Platform URL

https://[enterprise].cvtr.io/v2/campaigns/{campaignId}/admin/scheduled-delivery

API Endpoints

List all active publishers on the campaign for adding schedule

GET /api/v4/campaign-publishers?page=1&itemsPerPage=5&latest=true&currentContractStatus%5B%5D=active&publisher.id%5Bneq%5D%5B%5D={publisherId}&campaign.id={campaignId}

Add publisher to scheduled delivery configuration

PUT /api/v4/scheduled-deliveries/{scheduleId}

List the scheduled delivery configuration

GET api/v4/scheduled-deliveries?page=1&itemsPerPage=1&campaign.id={campaignId}

Epic

CON-5548 - Getting issue details... STATUS

Document status

READY FOR REVIEW

Document owner

Danny Hannah Adam Carter

Technical writers

Arunima Kurup Prasad

Related Content

Publisher Type Schedule Configuration

🏠 Feature Overview

The ‘Add Publisher(s)’ button on the Scheduled Delivery page is enabled only for Publisher based scheduled delivery so that the schedule can be configured separately for the different publishers on the campaign.

Clicking the button opens the 'Add Publisher(s)’ modal that lists all the active publishers on the campaign.

Screenshot 2024-04-17 at 16.25.53.png

To configure scheduled delivery for a publisher, the user ust click on the checkbox corresponding to that publisher.

Screenshot 2024-04-17 at 16.26.03.png

When a particular publisher is selected, the ‘Max Cap’ column and ‘Schedule’ column are available for configuration.

‘Max Cap’ configuration

  • When publisher bands are not enabled on the campaign, Max Cap refers to the maximum number of leads that can be held by scheduled delivery in a single schedule.

In the below case, a maximum of 10 valid leads will be held by the schedulr until it is delivered at the schedule time.

Screenshot 2024-04-17 at 15.21.08.png
  • When publisher bands are enabled on the campaign, Max Cap can be set as the maximum number of leads that can be held either for the entire schedule or for the selected band by toggling the ‘Band Level’ toggle off or on respectively.

Screenshot 2024-04-17 at 15.22.41.png
  • When publisher bands are enabled, the ‘Band Level’ toggle under ‘Max Cap’ can be enabled to see the available bands and a max cap can be set for each band.

Screenshot 2024-04-17 at 15.14.26.png

The below configuration for Max Cap would mean that a maximum of 5 leads can be delivered for the band ‘UK’ and a maximum of 10 leads can be delivered for the band ‘US’ in a single schedule of scheduled delivery. Since the max cap for the ‘Default’ band is set to 0, default leads (leads that do not fall into any of the configured publisher bands) will not be scheduled for delivery.

Screenshot 2024-04-17 at 15.15.55.png
  • Even if publisher bands are available on the campaign, the user can choose to configure the Max Cap for the entire set of leads and not at band level, by keeping the ‘Band Level' toggle disabled.

In the below scenario, we know that the campaign has publisher bands enabled because the ‘Band Level’ toggle is available under Max Cap. However, since the toggle is disabled, the max cap configured applies to the entire set of leads irrespective of the bands they fall into.

Screenshot 2024-04-17 at 15.24.50.png

Therefore valid leads that fall into bands as well as valid default leads will be considered and scheduled for delivery.

Schedule configuration

The schedule column shows the configuration widget that can be used to configure the delivery schedule. Details of configuring the schedule widget is available here.

The steps should be repeated for each of the publishers that need to deliver leads using scheduled delivery.

Screenshot 2024-04-17 at 16.27.04.png

Once schedule is configured for all the required publishers, the ‘Save’ button can be clicked to save the configuration and the user is redirected back to the scheduled delivery page where they can see the schedule details for the different publishers.

Screenshot 2024-04-17 at 16.27.17.png

It is not necessary to configure the schedule for all the publishers at once. The user can update scheduled delivery at any time to add a new publisher to the configuration.

\uD83D\uDDD2 Summary

Functionality

User Story

1

Ability to add publishers for scheduled delivery

Admin and Agency users can use the ‘Add Publisher(s)’ button to configure scheduled delivery for the different publishers so that each publisher has a separate lead delivery schedule.

\uD83D\uDDD2 User Permissions

Only Admin and Agency users have access to scheduled delivery.

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

  • No labels