Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Page Properties

Platform URL

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

API Endpoints

Retrieves the collection of AdvertiserCampaignDefault resources:

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

Creates a AdvertiserCampaignDefault resource:

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

Retrieves/Removes/Replaces a AdvertiserCampaignDefault resource:

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

Retrieving a list of campaigns:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/campaigns

Create a campaign/Quick campaign:

Code Block
POST https://{enterprise}.cvtr.io/api/v4/campaigns

Retrieving a list of advertisers:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/advertisers

Retrieving a list of forms:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/forms

Retrieving a list of processr jobs:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/processr-jobs

Retrieving a list of subcategories:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/subcategories

Retrieving list of countries:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/countries

Retrieving information of the users/permissions:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/users

Retrieving list of currencies:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/currencies

Duplicate/Import a campaign:

Code Block
POST https://{enterprise}.cvtr.io/api/v4/campaigns/{campaign_id}/duplicate

Go to campaign details:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/campaign-links

Customisation of the campaign table column:

Code Block
PUT https://{enterprise}.cvtr.io/api/v4//api/v4/user-settings/advertiser-campaigns-list-key

Epic

Jira Legacy
serverSystem JIRA
serverId47839f05-61cf-355f-8da7-a069f30ee70e
keyDAS-14

Document status

Status
colourGreen
titleREVIEWED

Document owner

Danny Hannah Adam Carter

Technical writer(s)

Arunima Kurup Prasad Muge Budak

Related Content

Advertisers

🏠 Feature Overview

Advertiser user can set up multiple campaigns per advertiser and publishers may be assigned to campaigns to submit leads to the campaigns.

...

Field Name

Required

Notes

Currency

(tick)

Conversion Rate

(error)

Uncapped

(error)

Whether capped or capped campaign

Volume Required

(tick)

When campaign is capped

Total Contract Value

(tick)

When campaign is capped

Payout metric

(tick)

Publisher Payout metric

(tick)

Per action payout amount

(tick)

Default Publisher Rate

(tick)

Payout Restrictions & Terms

(error)

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.

...

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.

...

When importing an advertiser’s existing campaign, the user can choose whether to import associated settings such as Publishers, Publisher bands, Scheduled Delivery, etc. By doing so, the effort required to configure a new campaign is reduced.

...

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

Advertiser

(tick)

Campaign to Import

(tick)

New campaign name

(tick)

Leads Required

(tick)

Currency

(tick)

Per action payout amount

(tick)

Start Date and End Date

(tick)

Test Mode

(error)

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

(error)

The user can select the configurations they want to import from the parent 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.

...

\uD83D\uDDD2 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 > 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

\uD83D\uDDD2 User Permissions

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

...