Import Campaign
- Arunima Kurup Prasad
Platform URL | https://[enterprise].cvtr.io/v2/advertisers/[advertiserId]/list-campaigns |
|---|---|
API Endpoints | Retrieving a list of campaigns: GET https://{enterprise}.cvtr.io/api/v4/campaignsRetrieving a list of advertisers: GET https://{enterprise}.cvtr.io/api/v4/advertisersRetrieving information of the users/permissions: GET https://{enterprise}.cvtr.io/api/v4/usersRetrieving list of currencies: Duplicate/Import a campaign: |
Epic | |
Document status | REVIEWED |
Document owner | @Danny Hannah @Adam Carter |
Technical writer(s) | @Arunima Kurup Prasad |
Related Content |
Feature Overview
This feature enables the user to Import an existing campaign from an advertiser. This is helpful when the user needs to create a campaign that has similar settings of an existing campaign.
Campaigns can be imported from within the same advertiser or from another advertiser. If campaign is imported within same advertiser, all campaign permissions will be retained.
If campaign is imported to another advertiser, user is shown the below dialog warning that any validation lists and permissions will not be carried over to the imported campaign.
In the import modal, the user can specify:
the advertiser whose campaign needs to be imported
the campaign that is to be imported
name of new campaign
leads required
currency
per action payout amount
start date and end date for the campaign
User does not have to fill in other details like jobs, forms, category, country etc. They are automatically copied over to the imported campaign and reduces the time required to setup a campaign.
Additionally, there is a ‘Test Mode’ that may be enabled on the imported campaign, which will in turn make all leads Test and will not deliver to integrations. This is useful when a master campaign is configured to be used as a template. Since it is a template configuration, we do not want leads to be delivered to integrations, hence it can be configured with ‘Test Mode’ enabled so the leads are all test. When such a master campaign is imported, the user can specify if they want the imported campaign also to be a test campaign or not using the ‘Test Mode’ configuraion.
The ‘Import Campaign’ modal also has an ‘Include’ section with values:
Publishers
Landing Pages and Forms
Creative Assets
Links
Payout Bands
Value Transforms
During the import, the user can select the configurations they need to copy over to the imported campaign. The user can select any/all/none of the configurations to be copied over to the imported campaign.
Field Name | Required | Notes |
|---|---|---|
Advertiser |
| |
Campaign to Import |
| |
New campaign name |
| |
Leads Required |
| |
Currency |
| |
Per action payout amount |
| |
Start Date and End Date |
| |
Test Mode | When enabled, leads coming in to the campaign will be marked as test and will not be integrated. | |
Include configurations:
| The user can select the configurations they want to import from the parent campaign |
Quick Campaign
Another option to create campaigns easily is using the ‘Quick Campaign’ functionality. This option will be enabled for an Advertiser if ‘Performance Model', Sector’ and ‘Default Publisher Rates’ are configured in the Advertiser’s Default Value Settings (see Related Content above for details).
Clicking on the ‘Quick Campaign’ button will open the below modal where the user needs to enter the bare minimum details to create a campaign. Any default settings available in Advertiser > Default Value Settings will be available in the newly created campaign.
Summary
Functionality | User Story | |
|---|---|---|
| 1 | Campaigns Listing | Users can see the campaigns listing under tabs: Active and Inactive. By clicking on the ‘Campaign Name’ hyperlink, they can navigate to the campaign overview page |
| 2 | Campaigns > Import | User can Import campaigns of any advertiser using the ‘Import Campaign’ button and including the required settings |
User Permissions
Admin users and agency users associated with the advertiser can access the Advertisers tab to create/import campaigns.