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 13 Next »

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:

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

Create a campaign/Quick campaign:

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

Retrieving a list of advertisers:

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

Retrieving a list of forms:

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

Retrieving a list of processr jobs:

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

Retrieving a list of subcategories:

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

Retrieving list of countries:

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

Retrieving information of the users/permissions:

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

Retrieving list of currencies:

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

Duplicate/Import a campaign:

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

Go to campaign details:

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

Customisation of the campaign table column:

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

Epic

DAS-14 - Getting issue details... STATUS

Document status

REVIEWED

Document owner

Danny Hannah Adam Carter

Technical writer(s)

Arunima Kurup Prasad Muge Budak

Related Content

Default Value Settings

🏠 Feature Overview

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

The Campaigns tab lists the Advertiser campaigns and provides options for the user to create campaigns and import campaigns.

Campaign Listing

Active and inactive campaigns are listed under 2 separate tabs- ‘Active Campaigns’ and ‘Inactive Campaigns’ respectively. The user can use the custom table settings to select the details to be shown in the table, such as the campaign ID, name, status, etc.

Users can utilise the search and sort options available for some of the fields such as campaign name, country and duration to search for values and sort the records.

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

Performance Model

(tick)

CPL (Cost Per Lead)

Sector

(tick)

Category

(tick)

Created under System > Categories

Start Date and End Date

(tick)

End Date Extension

(error)

Unavailable Campaign Logic

(tick)

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

Publisher Imports & Exports

(error)

Whether to allow publishers to import/export their data

Publisher Delivery

(error)

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

Advertiser

(tick)

Campaign Name

(tick)

Account Manager

(error)

Campaign Manager

(error)

Country

(error)

Purchase/Insertion order No.

(tick)

Additional Reference Numbers

(error)

Permissions

(error)

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

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)

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

Compliance Optin Method

(tick)

Landing Page Provider

(tick)

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

Data Capture Form

(tick)

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

Global Forms

(tick)

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

Default Destination URL

(error)

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

Secondary Destination URL

(error)

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

Endpoint

(error)

Realtime Delivery

(error)

Call centre services

(error)

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.

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.

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

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.

As with newly created campaigns, the campaigns that are imported/created using Quick campaign will need to be activated by the advertiser by signing the respective contract.

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

  • No labels