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
titleDRAFT

Document owner

Arunima Kurup Prasad

Technical writers

Arunima Kurup Prasad

Muge Budak

Related Content

🏠 Feature Overview

...

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

DescriptionRequired

Whether MandatoryNotes

Performance Model

(tick)

Sector

(tick)

Category

(tick)

Start Date and End Date

(tick)

End Date Extension

(error)

Unavailable Campaign Logic

(tick)

Publisher Imports & Exports

(error)

Publisher Delivery

(error)

>>>>add screenshot

ii. Owner: This tab captures the ownership details such as account manager, campaign manager of the campaign

Field Name

DescriptionRequired

Whether MandatoryNotes

Advertiser

(tick)

Campaign Name

(tick)

Account Manager

(error)

Campaign Manager

(error)

Country

(error)

Purchase/Insertion order No.

(tick)

Additional Reference Numbers

(error)

Permissions

(error)

>>>>add screenshot

iii. Financials: This tab captures the financial details such as Contract Value

Field Name

DescriptionRequired

Whether MandatoryNotes

Currency

(tick)

Conversion Rate

(error)

Uncapped

(error)

Volume Required

(tick) when capped

Total Contract Value

(tick) when capped

Payout metric

(tick)

Publisher Payout metric

(tick)

Per action payout amount

(tick)

Default Publisher Rate

(tick)

Payout Restrictions & Terms

(error)

>>> add screenshot

iv. Tracking: This tab captures details of

Field Name

DescriptionRequired

Whether MandatoryNotes

Compliance Optin Method

(tick)

Landing Page Provider

(tick)

Data Capture Form

(tick)

when hosted with enterprise

Global Forms

✅ when (tick)

Default Destination URL

when hosted with advertiser

>>>> add screenshot

v. Jobs: Using this tab, user can configure the Processr jobs to run for the campaign. The jobs: are selected by default and user may unselect them

>>>>>>> add screenshot

vi. Delivery: This tab captures the ….

Field Name

DescriptionRequired

Whether MandatoryNotes

Endpoint

(error)

Realtime Delivery

(error)

Call centre services

(error)

>>>>>add screenshot

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 edit them by going back to the relevant tab

>>>> add screenshot

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. 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 campaign is reduced.

>>>> description>>>>>

Field Name

DescriptionRequired

Whether MandatoryNotes

Advertiser

Campaign to Import

New campaign name

Leads Required

Currency

Per action payout amount

Start Date and End Date

Include (features)

(error)

add screenshot

Quick Campaign>>>> description>>>>>

Another option to create campaigns easily is using the ‘Quick Campaign’ functionality. This option will be enabled for an Advertiser if ‘Performance Sector’ and ‘Default Publisher Rates’ are configured in Default Value Settings. Clicking on the ‘Quick Campaign’ button….

add screenshot

\uD83D\uDDD2 User Permissions

...