/
Create Campaign

Create Campaign

Platform URL

https://[enterprise].cvtr.io/v2/advertisers/[advertiserId]/list-campaigns

API Endpoints

Retrieves the collection of AdvertiserCampaignDefault resources:

GET https://{enterprise}.cvtr.io/api/v4/advertiser-campaign-defaults

Creates a AdvertiserCampaignDefault resource:

POST https://{enterprise}.cvtr.io/api/v4/advertiser-campaign-defaults

Retrieves/Removes/Replaces a AdvertiserCampaignDefault resource:

GET/DELETE/PUT https://{enterprise}.cvtr.io/api/v4/advertiser-campaign-defaults/{id}

Retrieving a list of campaigns:

Create a campaign

Retrieving a list of advertisers:

Retrieving a list of forms:

Retrieving a list of processr jobs:

Retrieving a list of subcategories:

Retrieving list of countries:

Retrieving information of the users/permissions:

Retrieving list of currencies:

Go to campaign details:

 

Epic

https://convertr.atlassian.net/browse/DAS-14

Document status

REVIEWED

Document owner

@Danny Hannah @Adam Carter

Technical writer(s)

@Arunima Kurup Prasad

Related Content

Advertisers

Feature Overview

Campaigns are created at Advertiser level. To create a new campaign, go to Advertisers menu and select an advertiser against which campaign is to be created.

Click on the ‘Create Campaign’ button.

Create Campaign

Clicking on the ‘Create Campaign’ button initiates campaign creation, which requires entering the required fields in 7 steps, as described below.

i. Metrics: The user has to provide the below values in the Metrics tab

Field Name

Required

Notes

Field Name

Required

Notes

Performance Model

CPL (Cost Per Lead)

Sector

 

Category

Created under System > Categories

Start Date and End Date

 

End Date Extension

 

Unavailable Campaign Logic

Whether to allow leads to campaign/redirect to another URL or show a screen that the campaign has ended

Publisher Imports & Exports

Whether to allow publishers to import/export their data

Publisher Delivery

Whether to hold publisher over-delivery

ii. Owner: This tab captures the ownership details such as account manager, campaign manager, etc. of the campaign. The users associated with the advertiser are listed under Permissions. By using the toggle option under ‘Access’ column, users can be permitted/denied access to the campaign.

Field Name

Required

Notes

Field Name

Required

Notes

Advertiser

 

Campaign Name

 

Account Manager

 

Campaign Manager

 

Country

 

Purchase/Insertion order No.

 

Additional Reference Numbers

 

Permissions

Define permissions as to which users can manage the campaign

iii. Financials: This tab captures the financial details of the campaign. The values differ slightly for Capped and Uncapped campaigns. Below screenshot is for an Uncapped campaign.

The below screenshot is for a capped campaign. Since the campaign is capped, it is required to enter details such as Volume required and Total contract value.

Field Name

Required

Notes

Field Name

Required

Notes

Currency

 

Conversion Rate

 

Uncapped

Whether capped or capped campaign

Volume Required

When campaign is capped

Total Contract Value

When campaign is capped

Payout metric

 

Publisher Payout metric

 

Per action payout amount

 

Default Publisher Rate

 

Payout Restrictions & Terms

Any payout restrictions, terms may be added here

iv. Tracking: This tab captures details of tracking data such as Opt in method, landing page, forms etc. Single opt in is a one-time agreement between the user and the data capture method to confirm users are happy with their information being captured.

With Double opt in, a followup confirmation by the user is required after the initial opt in. This is achieved via an email sent to trigger the secondary opt in after the initial data capture form has been completed.

Field Name

Required

Notes

Field Name

Required

Notes

Compliance Optin Method

 

Landing Page Provider

Whether to use the enterprise’s landing page or external website

Data Capture Form

When ‘Landing Page Provider’ selected is ‘Host with enterprise’

Global Forms

When ‘Data Capture Form’ selected is 'Associate Form'

Default Destination URL

When ‘Landing Page Provider’ selected is ‘Host with advertiser’

Secondary Destination URL

When ‘Landing Page Provider’ selected is ‘Host with advertiser’

v. Jobs: Using this tab, user can configure the Processr jobs to run for the campaign. Some jobs like ‘Test Data Check’ and ‘Non Standard Character Check’ are selected by default and user may deselect them and enable other jobs on the campaign.

vi. Delivery: This tab captures the Integration/Delivery details such as the below.

Field Name

Required

Notes

Field Name

Required

Notes

Endpoint

 

Realtime Delivery

 

Call centre services

 

vii. Review: This tab shows the summary of the values entered for all the fields in all the previous tabs. This helps the user to verify the details and if required, edit them by going back to the relevant tab.

Once the user has entered all the required details, reviewed them and clicked on Save in Review tab, the new campaign will be created for the advertiser and the user will be redirected to the Campaign’s Overview page. The contract needs to be signed by the advertiser for the campaign to be active.

An email will be sent to the advertiser’s mail id configured in Advertisers > Account, to sign the contract and activate the campaign. Unless activated, the campaign will remain in the Inactive Campaigns listing, with status: 'Setup Required'

Once the contract is signed, the campaign will move to the Active Campaigns listing. The advertiser can then assign publishers to the campaign.

Import Campaign

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 and other campaign settings. 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

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:

  • Publishers

  • Scheduled Deliveries

  • Landing Pages and Forms

  • Creative Assets

  • Links

  • Payout Bands

  • Value Transforms

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

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 > Create

Users can create new campaigns using the ‘Create Campaign’ button and entering the required details in multiple tabs

3

Campaigns > Import

User can Import campaigns of any advertiser using the ‘Import Campaign’ button and including the required settings

4

Campaign > Quick Campaign

Users can use the ‘Quick Campaign’ option to create campaigns quickly without entering all the details

5

Table Download

Allows user to download the campaigns shown on the table

6

Table Filtering

Allows the user to filter some of the table values

7

Custom Tables

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

 User Permissions

Admin users and agency users associated with the advertiser can access the Advertisers tab to create/import campaigns.

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

Related content

Campaign Listing
Campaign Listing
More like this
Setup
More like this
Value Transformations
Value Transformations
More like this
Import Campaign
Import Campaign
More like this
Publishers
More like this
Advertisers
Advertisers
More like this